chuchichaestli
chuchichaestli is a collection of model architectures and other useful bits of code in use at the Intelligent Vision Systems group at the University of Applied Sciences Zurich (ZHAW).
Installation
Tagged releases are available as PyPI packages. To install the latest package, run:
pip install chuchichaestli
For the bleeding-edge package directly from the git main, clone the repository and run the following command in the root directory of the repository:
pip install -e .
Alternatively, you can install the package directly from GitHub:
pip install git+https://github.com/CAIIVS/chuchichaestli.git
Development
Releases and packages are automatically created with various GitHub action workflows. The general development workflow is as follows
- checkout to a non-default branch to apply patches, features, etc.
- each commit to a non-default branch triggers an install test (on latest Python versions) and a package build
- open a PR
- at opening and each subsequent commit to that PR, the build is uploaded to TestPyPI and a dev version is incremented (e.g. v1.2.0 -> v1.2.0-dev0)
- once the PR is reviewed, it can be merged
- at merge, the micro version is incremented on the main branch and tagged (e.g. v1.2.0-dev7 -> v1.2.1)
- subsequently, a package is built, published to PyPI, and released on GitHub with the latest version tag
- every once in a while it is necessary to bump minor or major versions
- minor and major version can be triggered, by manually dispatching the
on_dispatch.ymlworkflow - on the web interface (using the option
minorormajor), or - on CLI with
gh workflow run on_dispatch.yml -f type=minor(or-f type=major)
Reusable workflows
In .github/workflows/ there are several reusable workflows which
provide the basic utility for the triggered jobs:
test-install.yml- test install on the supported Python endpoints, 3.10 and 3.13, by default;
pass
full-matrix: trueto sweep every supported version (the release workflow does) - ruff linting checks (stop build if error occurs)
- run unit tests with pytest and collect coverage (fails below the
coverage-thresholdinput) - upload test results (for prosperity)
- test install on the supported Python endpoints, 3.10 and 3.13, by default;
pass
build-package.yml- build package with
uv buildon Python 3.13 by default; passversions(a JSON array) to build on several, if wheels are ABI-specific - upload one dist artifact per Python version, named
<artifact-name>-<version>
- build package with
github-release.yml- download all dist artifacts matching
<artifact-name>-*and merge them - sign package dist with Sigstore
- create and upload GitHub release
- download all dist artifacts matching
publish-to-pypi.yml- download all dist artifacts matching
<artifact-name>-*and merge them - publish to PyPI, or to TestPyPI when called with
test: true
- download all dist artifacts matching
deploy-docs.yml- build the docs with MkDocs and publish them to GitHub Pages
- uses the Pages artifact flow (
upload-pages-artifact+deploy-pages), not agh-pagespush - can be run manually via
gh workflow run deploy-docs.yml
phdenzel/pyverto@v*- use pyverto to increment a version
- commit and push changes
Triggered workflows
on_branches.yml- triggers on commit to any branch (except
main) not in a PR (pull request) - runs
test-install-python-versionandbuild-package
- triggers on commit to any branch (except
on_pr.yml- triggers on commit to a PR
- runs
test-install-python-version,build-package,publish-to-testpypi, andversion-bump-dev
on_merge.yml- triggers on PR merge
- runs
version-bump-on-merge(increments micro version on main)
on_push.yml- triggers on push to the main branch upon automatic version change
- runs
test-install-python-version,build-package,publish-to-pypi,github-release,deploy-docs
on_dispatch.yml- triggers on dispatch (e.g. by running
gh workflow run on-dispatch.yml -f type=minor) - runs
version-bump(increments chosen type of version on main)
- triggers on dispatch (e.g. by running
1 maintainer
Metadata
1 maintainer
Release files for chuchichaestli 0.3.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| chuchichaestli-0.3.3.tar.gz | 584.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| chuchichaestli-0.3.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 824.8 kB
Release files / chuchichaestli-0.3.3.tar.gz
| Download URL | chuchichaestli-0.3.3.tar.gz |
|---|---|
| Size | 584.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ecec7a926638fa70f9df8216925cbe9e26e5d5885ece20e0de196c30f2682acb
|
|
BLAKE2b-256 checksum How to use checksums |
08d00e014d900441678ed3a6b267ef93975cd16d15612bce130d8eb98663901e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / chuchichaestli-0.3.3-py3-none-any.whl
| Download URL | chuchichaestli-0.3.3-py3-none-any.whl |
|---|---|
| Size | 240.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
710536e1bfe052b267f2b5d182f4ce98a94b0a00d07211fe478616d686f9274d
|
|
BLAKE2b-256 checksum How to use checksums |
6061941234f88b9735796f7be4fcdb92cdcd890d0e3a1f184308e25a67cbe171
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
