Metadata-Version: 2.4
Name: robust-python
Version: 0.0.1
Summary: robust-python
Author-email: Kyle Oliver <56kyleoliver+robust-python@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/56kyle/robust-python
Project-URL: Repository, https://github.com/56kyle/robust-python
Keywords: robust-python
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Development Status :: 1 - Planning
Requires-Python: <4.0,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: loguru>=0.7.3
Requires-Dist: platformdirs>=4.3.8
Requires-Dist: typer>=0.15.4
Requires-Dist: typing-extensions>=4.13.2
Dynamic: license-file

# robust-python

robust_python

---

**[📚 View Documentation](https://robust-python.readthedocs.io/)** | **[🐛 Report a Bug](https://github.com/56kyle/robust-python/issues)** | **[✨ Request a Feature](https://github.com/56kyle/robust-python/issues)**

---

## Installation

You can install `robust_python` via [pip](pip-documentation) from PyPI:

```bash
pip install robust_python
```

### Installation for Development

To set up `robust_python` for local development:

1.  Clone the repository:
    ```bash
    git clone https://github.com/56kyle/robust-python.git
    cd robust-python
    ```
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_python 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-python --help
# robust-python 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-python/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].**

<!-- Reference Links -->

[cookiecutter-robust-python]: https://github.com/robust-python/cookiecutter-robust-python
[documentation]: https://robust-python.readthedocs.io/
