pixel-canon 0.1.0

The canon for pixel data topology. A cross-language specification to define the logical layout of images.

Pixel-Canon: Python Implementation

This directory contains the Python implementation of the Pixel-Canon specification.

Development Setup

To work on this package locally, it is recommended to install it in "editable" mode inside a virtual environment.

1. Navigate to this directory:

   cd path/to/pixel-canon/python
   

2. Create a virtual environment:

   python -m venv .venv
   

3. Activate the virtual environment:

   • Windows (Command Prompt, cmd.exe):

     .venv\Scripts\activate.bat
     

   • Windows (PowerShell):

     # Если вы получаете ошибку о политике выполнения, сначала выполните:
     # Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process
     .venv\Scripts\Activate.ps1
     

   • macOS / Linux (bash/zsh):

     source .venv/bin/activate
     

4. Install the package in editable mode: This command will install the package and its dependencies, making it available system-wide (within the virtual environment) while allowing you to edit the source code directly.

   pip install -e .
   

   If you need the dependencies for running tests or specific backends, you can install them as extras:

   pip install -e ".[numpy]"
   

Running Tests

From the root of the python directory (pixel-canon/python), run the following command:

python -m unittest discover -s tests

This command explicitly tells unittest to start discovery in the tests subdirectory, ensuring all tests are found and executed correctly.

Publishing to PyPI

This is a guide for project maintainers.

1. Install build tools:

   pip install build twine
   

2. Clean up previous builds (optional but recommended):

   rm -rf build dist pixel_canon.egg-info
   

3. Build the package: This command creates the dist/ directory with a wheel (.whl) and a source archive (.tar.gz).

   python -m build
   

4. Upload to PyPI: You will be prompted for a username and password.

   • For username, enter __token__.
   • For password, paste your PyPI API token (including the pypi- prefix).

   python -m twine upload dist/*