https://github.com/56kyle/robust-maturin-demo
Demo repo used for testing cookiecutter-robust-python with rust extensions turned on
https://github.com/56kyle/robust-maturin-demo
Last synced: 10 months ago
JSON representation
Demo repo used for testing cookiecutter-robust-python with rust extensions turned on
- Host: GitHub
- URL: https://github.com/56kyle/robust-maturin-demo
- Owner: 56kyle
- License: mit
- Created: 2025-05-28T23:47:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-02T01:20:59.000Z (10 months ago)
- Last Synced: 2025-08-02T02:38:01.985Z (10 months ago)
- Language: Python
- Size: 104 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# robust-maturin-demo
robust_maturin_demo
---
**[📚 View Documentation](https://robust-maturin-demo.readthedocs.io/)** | **[🐛 Report a Bug](https://github.com/56kyle/robust-maturin-demo/issues)** | **[✨ Request a Feature](https://github.com/56kyle/robust-maturin-demo/issues)**
---
## Installation
You can install `robust_maturin_demo` via [pip](pip-documentation) from PyPI:
```bash
pip install robust_maturin_demo
```
### Installation for Development
To set up `robust_maturin_demo` for local development:
1. Clone the repository:
```bash
git clone https://github.com/56kyle/robust-maturin-demo.git
cd robust-maturin-demo
```
2. Install dependencies using [:term:`uv`](uv-documentation):
```bash
uv sync
```
3. Install pre-commit hooks:
```bash
uvx nox -s pre-commit -- install
```
This sets up a virtual environment and installs core, development, and quality check dependencies.
## Usage
(This section should explain how to use the generated application. Replace the content below with instructions specific to your project's functionality. If your project is a library, show import examples. If it's a CLI application, show command examples. Link to the full documentation for details.)
### As a Library
```python
# Example usage of your package as a library
# from robust_maturin_demo import some_function
# result = some_function()
# print(result)
```
### As a Command-Line Application
If your project defines command-line entry points in `pyproject.toml`:
```bash
# Example usage of your CLI application
# robust-maturin-demo --help
# robust-maturin-demo do-something --input file.txt
```
For detailed API documentation and CLI command references, see the **[Documentation][documentation]**.
## Development Workflow
This project uses a robust set of tools for development, testing, and quality assurance. All significant automated tasks are run via [:term:`Nox`](nox-documentation), orchestrated by the central `noxfile.py`.
- **Run all checks (lint, typecheck, security):** `uvx nox -s check`
- **Run test suite with coverage:** `uvx nox -s test`
- **Build documentation:** `uvx nox -s docs`
- **Build package:** `uvx nox -s build`
- **See all available tasks:** `uvx nox -l`
Explore the `noxfile.py` and the project documentation for detailed information on the automated workflow.
## Contributing
(This section should guide contributions _to this specific generated project_, not the template. It should refer to the project's `CODE_OF_CONDUCT.md` and link to a `CONTRIBUTING.md` specific to the project, if you choose to generate one.)
Report bugs or suggest features via the [issue tracker](https://github.com/56kyle/robust-maturin-demo/issues).
See [CONTRIBUTING.md](#) for contribution guidelines.
## License
Distributed under the terms of the **MIT** license. See [LICENSE](LICENSE) for details.
---
**This project was generated from the [cookiecutter-robust-python template][cookiecutter-robust-python].**
[cookiecutter-robust-python]: https://github.com/56kyle/cookiecutter-robust-python
[documentation]: https://robust-maturin-demo.readthedocs.io/