Autocam

Features

• TODO

Requirements

• Python 3.9+
• Conda (for environment management)
• Poetry (for dependency management)

Installation

You can install Autocam via pip from PyPI:

$ pip install autocam

Development Setup

For development, clone the repository and set up the environment:

$ git clone https://github.com/phzwart/autocam.git
$ cd autocam
$ conda create -n autocam python=3.10 -y
$ conda activate autocam
$ pip install poetry
$ poetry install
$ poetry run pre-commit install

Run tests with:

$ poetry run nox

Release Process

Important: Do NOT create or push version tags manually.

The release workflow automatically:

• Detects version bumps in pyproject.toml
• Creates and pushes version tags (e.g., v1.2.3)
• Builds and publishes to PyPI
• Creates GitHub releases with release notes

To create a new release:

$ python scripts/bump_version.py [major|minor|patch]
$ git add pyproject.toml
$ git commit -m "Bump version to X.Y.Z"
$ git push

Do NOT run git tag or git push --tags.

See [Contributing] for more details.

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Autocam is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.