Metadata-Version: 2.2
Name: modcam
Version: 2025.3.2
Summary: Free and open source software for Computer Aided Manufacturing (CAM) research
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Manufacturing
Classifier: Topic :: Scientific/Engineering
Project-URL: homepage, https://github.com/modCAM/modcam-python
Requires-Python: >=3.9
Requires-Dist: numpy
Description-Content-Type: text/markdown

# modCAM Python bindings

[![PyPI version](https://badge.fury.io/py/modcam.svg)](https://badge.fury.io/py/modcam)

ModCAM is free and open source software for computer aided manufacturing (CAM) research. It is a library of algorithms for the control of manufacturing machinery, such as lathes, mills, and 3D printers.

These are the Python bindings for the [core (C++) modCAM library](https://github.com/modCAM/modcam). The Python package can be found on [PyPI](https://pypi.org/project/modcam/).

## Documentation

For tutorials and further information about the project in general, see the documentation at [https://modcam-docs.readthedocs.io/](https://modcam-docs.readthedocs.io/).

For a technical reference guide to the modCAM functions, see the [Python reference page](https://modcam-docs.readthedocs.io/projects/modcam-python/).

## Getting started

Getting started is as easy as `python -m pip install modcam`. Then, in your Python scripts, just `import modcam`.

## Communication channels

Questions about usage can be asked in [Discussions](https://github.com/modCAM/modcam-python/discussions).

For bug reports or Python-related enhancement suggestions, create an [Issue](https://github.com/modCAM/modcam-python/issues). For suggestions regarding general feature additions, create an [Issue in the C++ repo](https://github.com/modCAM/modcam/issues).

To report vulnerabilities, see [SECURITY.md](https://github.com/modCAM/modcam-python?tab=security-ov-file).

For private communication, email modCAM.github@proton.me.

All interactions with the modCAM community are expected to follow the [Code of conduct](https://github.com/modCAM/modcam-python?tab=coc-ov-file).

## Contributing

Enhancements and bug fixes are welcome. For instructions on how to contribute, see [the contributing guidelines](docs/CONTRIBUTING.rst).

## License

ModCAM is licensed under the [Mozilla Public License Version 2.0](LICENSE).
