# 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:
```bash
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:
```bash
pip install -e .
```
Alternatively, you can install the package directly from GitHub:
```bash
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
1) 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
2) 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)
3) 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
4) 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.yml` workflow
* on the web interface (using the option `minor` or `major`), 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 various Python versions (by default 3.10-3.12)
- ruff linting checks (stop build if error occurs)
- run unit tests with pytest
- upload test results (for prosperity)
* `build-package.yml`
- build package for Python version 3.x
- upload package dist artifacts (by name)
* `github-release.yml`
- download package dist artifact (by name)
- sign package dist with Sigstore
- create and upload GitHub release
* `phdenzel/hatch-bump@v*`
- use hatch 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-version` and `build-package`
* `on_pr.yml`
- triggers on commit to a PR
- runs `test-install-python-version`, `build-package`, `publish-to-testpypi`, and `version-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`
* `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)
Raw data
{
"_id": null,
"home_page": null,
"name": "chuchichaestli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Daniel Barco <baoc@zhaw.ch>, Philipp Denzel <denp@zhaw.ch>, Marc Stadelmann <stmd@zhaw.ch>",
"keywords": "artificial intelligence, deep learning, neural networks",
"author": null,
"author_email": "Yann Billeter <bily@zhaw.ch>, Daniel Barco <baoc@zhaw.ch>, Philipp Denzel <denp@zhaw.ch>, Martin Oswald <oswd@zhaw.ch>, Marc Stadelmann <stmd@zhaw.ch>",
"download_url": "https://files.pythonhosted.org/packages/9e/6c/3bd54f0f734147a54911fd77e852c6344f5ce326e0fdc3845e2daf44f973/chuchichaestli-0.2.14.tar.gz",
"platform": null,
"description": "# chuchichaestli\n\n`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).\n\n\n## Installation\n\nTagged releases are available as PyPI packages. To install the latest package, run:\n\n```bash\npip install chuchichaestli\n```\n\nFor the bleeding-edge package directly from the git main, clone the repository and run the following command in the root directory of the repository:\n\n```bash\npip install -e .\n```\n\nAlternatively, you can install the package directly from GitHub:\n\n```bash\npip install git+https://github.com/CAIIVS/chuchichaestli.git\n```\n\n## Development\n\nReleases and packages are automatically created with various GitHub\naction workflows. The general development workflow is as follows\n\n1) checkout to a non-default branch to apply patches, features, etc.\n * each commit to a non-default branch triggers an install test (on latest Python versions) and a package build\n2) open a PR\n * 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)\n3) once the PR is reviewed, it can be merged\n * at merge, the micro version is incremented on the main branch and tagged (e.g. v1.2.0-dev7 -> v1.2.1)\n * subsequently, a package is built, published to PyPI, and released on GitHub with the latest version tag\n4) every once in a while it is necessary to bump minor or major versions\n * minor and major version can be triggered, by manually dispatching the `on_dispatch.yml` workflow \n * on the web interface (using the option `minor` or `major`), or\n * on CLI with `gh workflow run on_dispatch.yml -f type=minor` (or `-f type=major`)\n\n\n### Reusable workflows\n\nIn `.github/workflows/` there are several reusable workflows which\nprovide the basic utility for the triggered jobs:\n\n* `test-install.yml`\n - test install on various Python versions (by default 3.10-3.12)\n - ruff linting checks (stop build if error occurs)\n - run unit tests with pytest\n - upload test results (for prosperity)\n* `build-package.yml`\n - build package for Python version 3.x\n - upload package dist artifacts (by name)\n* `github-release.yml`\n - download package dist artifact (by name)\n - sign package dist with Sigstore\n - create and upload GitHub release\n* `phdenzel/hatch-bump@v*`\n - use hatch to increment a version\n - commit and push changes\n\n\n### Triggered workflows\n\n* `on_branches.yml`\n - triggers on commit to any branch (except `main`) not in a PR (pull request)\n - runs `test-install-python-version` and `build-package`\n* `on_pr.yml`\n - triggers on commit to a PR\n - runs `test-install-python-version`, `build-package`, `publish-to-testpypi`, and `version-bump-dev`\n* `on_merge.yml`\n - triggers on PR merge\n - runs `version-bump-on-merge` (increments micro version on main)\n* `on_push.yml`\n - triggers on push to the main branch upon automatic version change\n - runs `test-install-python-version`, `build-package`, `publish-to-pypi`, `github-release`\n* `on_dispatch.yml`\n - triggers on dispatch (e.g. by running `gh workflow run on-dispatch.yml -f type=minor`)\n - runs `version-bump` (increments chosen type of version on main)\n",
"bugtrack_url": null,
"license": null,
"summary": "Where you find all the state-of-the-art cooking utensils (salt, pepper, gradient descent... the usual).",
"version": "0.2.14",
"project_urls": {
"Documentation": "https://github.com/CAIIVS/chuchichaestli#readme",
"Homepage": "https://github.com/CAIIVS/chuchichaestli",
"Issues": "https://github.com/CAIIVS/chuchichaestli/issues",
"Repository": "https://github.com/CAIIVS/chuchichaestli.git",
"Source": "https://github.com/CAIIVS/chuchichaestli"
},
"split_keywords": [
"artificial intelligence",
" deep learning",
" neural networks"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5fd6530c9527ff59fd223635a30e60b2d266e51f2030ce26e1ad8c9ba2f4bff4",
"md5": "5e591b83caf15da40d3af252491c63a5",
"sha256": "2f45dd977b21f1535f4041af33cc6d7bbc7aafc17539cae1b8212b0060715957"
},
"downloads": -1,
"filename": "chuchichaestli-0.2.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e591b83caf15da40d3af252491c63a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 93486,
"upload_time": "2025-08-14T07:54:21",
"upload_time_iso_8601": "2025-08-14T07:54:21.034308Z",
"url": "https://files.pythonhosted.org/packages/5f/d6/530c9527ff59fd223635a30e60b2d266e51f2030ce26e1ad8c9ba2f4bff4/chuchichaestli-0.2.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9e6c3bd54f0f734147a54911fd77e852c6344f5ce326e0fdc3845e2daf44f973",
"md5": "fd0f01eb683131beb25a8d531a1a51be",
"sha256": "b4b706786768a94aa66c47347dd41c2d0cbe2f3fbaa8e3f8f3edd1f48f516fd0"
},
"downloads": -1,
"filename": "chuchichaestli-0.2.14.tar.gz",
"has_sig": false,
"md5_digest": "fd0f01eb683131beb25a8d531a1a51be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 307267,
"upload_time": "2025-08-14T07:54:22",
"upload_time_iso_8601": "2025-08-14T07:54:22.426154Z",
"url": "https://files.pythonhosted.org/packages/9e/6c/3bd54f0f734147a54911fd77e852c6344f5ce326e0fdc3845e2daf44f973/chuchichaestli-0.2.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-14 07:54:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CAIIVS",
"github_project": "chuchichaestli#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chuchichaestli"
}
JSON
