Metadata-Version: 2.4
Name: pixion
Version: 0.1.0
Summary: Tools and Library built at Pixel Perception
License: GNU General Public License v3
License-File: LICENSE
Keywords: python
Author: Saurabh Khanduja
Author-email: khandujasaurabh@gmail.com
Requires-Python: >=3.9
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Project-URL: Bug Tracker, https://github.com/saurabheights/pixion/issues
Project-URL: Documentation, https://python-poetry.org/docs/
Project-URL: Repository, https://github.com/saurabheights/pixion
Description-Content-Type: text/markdown

<!-- Tip - Pycharm supports easy updating Table of Comment (TOC) using Alt+Enter -->
<!-- TOC -->
* [Pixel Perception Lib](#pixel-perception-lib)
  * [Introduction](#introduction)
  * [Setup](#setup)
    * [Developer Dependencies](#developer-dependencies)
      * [Taskfile](#taskfile)
      * [Ruff](#ruff)
      * [Pre-Commit Hook](#pre-commit-hook)
  * [License](#license)
<!-- TOC -->

# Pixel Perception Lib

## Introduction

Tools and Library built at Pixel Perception

## Installing the library

```bash
pip install pixion
```

## Setup

### Developer Dependencies

#### Taskfile

We use [Taskfile](https://taskfile.dev/) to allow developers to run common tasks. Do enable [autocompletion](https://taskfile.dev/installation/#setup-completions).

```shell
sudo snap install task --classic
echo 'eval "$(task --completion bash)"' >> ~/.bashrc
```

#### Ruff

To apply ruff checks and formatting, run:
```shell
task run-lint
```

#### Pre-Commit Hook

You can use pre-commit to trigger `ruff check` and `ruff format` to run on each git commit. 

```shell
pip install pre-commit
pre-commit install
```

## License

Distributed under the terms of the `GNU General Public License v3`.

