Orchestr-ANT-ion

logo

Orchestr-ANT-ion

👨🏻‍💻 Fast python AI prototyping 🐍

Docs can be found here.

Build + test + run on Linux natively - x86-64/arm64 Windows 2025 Workflow CodeQL Donate Twitter

Orchestr-ANT-ion#

Table of Contents#

About The Project#

This project is a starting point for my Python AI workloads.
Use it as a starting point for creating and deploying your own Python projects.

Key Features#

  • Features are to be adjusted to your own project needs.

Category

Feature

Implement Status

Packaging agnostic

Binary only deployment

✔️

Lore ipsum

✔️

Infrastructure

Add hydra support

❌

Lore ipsum agnostic

Advanced unit testing

🔶

Advanced performance testing

🔶

Advanced fuzz testing

🔶

Legend:

  • ✔️ - completed

  • 🔶 - in progress

  • ❌ - not started

Dependencies#

  • Adjust according to your project’s actual Python and library dependencies.

Useful Tools#

Tool

Description

ty

ty

ruff

Linter

uv

Command-line utility

kedro

Infrastructure

miniforge3

Infrastructure

scalene

Benchmarking

py-spy

Benchmarking

Overview#

The versioning of the package can be viewed in CHANGELOG.md.

Getting Started#

Setup#

Feel free to adjust for your own environment. F.e. create a virtual venv with a specific python version.

uv venv
python3.11 -m venv .venv

Pre commit hook#

uv venv
source .venv/bin/activate # .venv/Scripts/activate on pwsh
uv pip install pre-commit
pre-commit install
# run on all files once (optional)
pre-commit run --all-files

Installation#

There are three major ways to install this package in your environment:

  1. Install directly via pip:

    pip install Orchestr-ANT-ion@git+https://github.com/Kataglyphis/Orchestr-ANT-ion

    or install a specific tagged version:

    pip install Orchestr-ANT-ion@git+https://github.com/Kataglyphis/Orchestr-ANT-ion@v0.0.1

  2. Install after cloning the repo:

    git clone --recurse-submodules https://github.com/Kataglyphis/Orchestr-ANT-ion
pip install .

    or

    pip install -e .

    (an editable install: changes in the repo will be reflected in your environment)

  3. Add as a submodule to your repository:

    git submodule add https://github.com/Kataglyphis/Orchestr-ANT-ion

    Make sure that all dependencies are installed during your repo’s installation.
    (Not generally recommended, as it can be more complicated.)

Picamera web browser live stream#

You need to shared system packages for the picamera2 should be installed via apt (source)

sudo apt install python3-picamera2
uv venv --system-site-packages

Deployment Recommendations (Hardware/Software)#

Python package deployment in pure C#

For insights into deploying Python packages into production as “binary only” wheels have a look into the corresponding workflows.

After creating the wheel you can check content with the command:

# Unzip a .whl
python -m zipfile --extract <ZIP_DATEI> <ZIEL_ORDNER>

This will print all available compatible tags for deployment

pip debug --verbose

./scripts/linux/ci_static_analysis.sh > "ci_analysis_$(date +%Y%m%d_%H%M%S).log" 2>&1

NOTE: If you want to install your package editable and you previously deployed
it you will need to delete all Cython generated files first. You can use the following
command for it:

find . -type f \( -name '\*.c' -o -name '\*.cpp' -o -name '\*.so' -o -name '\*.pyd' -o -name '\*.html' \) -delete

Or on windows … do this

Get-ChildItem -Path . -Recurse -File | Where-Object { $\_.Extension -in '.c', '.cpp', '.so', '.pyd', '.html' } | Remove-Item

Tests#

For development, you can install comprehensive dependencies with:

pip install -v -e .[dev,docs,test]

Then run your testing framework (e.g., pytest).

Roadmap#

Specify planned features or improvements here.

Demos#

uv run python -m orchestr_ant_ion.yolo.monitor

Contributing#

Contributions make open source software better! To contribute:

  1. Fork the project

  2. Create your feature branch (git checkout -b feature/AmazingFeature)

  3. Commit your changes (git commit -m 'Add some AmazingFeature')

  4. Push to the branch (git push origin feature/AmazingFeature)

  5. Open a Pull Request

License#

Use or adapt your license here.

Contact and Maintainers#

Maintainers:
Replace this text with the list of maintainers who can be asked and assigned to review or merge requests.

Acknowledgements#

Mention credits for any third-party resources.

Literature#

List helpful literature, tutorials, or references that have guided this project.

Deployment#

Protect source code#

Demo#

If you have examples or demonstrations, add them here.

References#

Orchestr-ANT-ion is used in the following repos/packages:

  • Adapt this list to reference actual uses.

Known Issues#

List any known issues here.