robust-python-demo 0.10.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- robust_python_demo/__init__.py +1 -0
- robust_python_demo/__main__.py +15 -0
- robust_python_demo/py.typed +0 -0
- robust_python_demo-0.10.0.dist-info/METADATA +110 -0
- robust_python_demo-0.10.0.dist-info/RECORD +8 -0
- robust_python_demo-0.10.0.dist-info/WHEEL +5 -0
- robust_python_demo-0.10.0.dist-info/licenses/LICENSE +21 -0
- robust_python_demo-0.10.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1 @@
|
|
1
|
+
"""Robust Python Demo."""
|
File without changes
|
@@ -0,0 +1,110 @@
|
|
1
|
+
Metadata-Version: 2.4
|
2
|
+
Name: robust-python-demo
|
3
|
+
Version: 0.10.0
|
4
|
+
Summary: robust-python-demo
|
5
|
+
Author-email: Kyle Oliver <56kyleoliver+cookiecutter-robust-python@gmail.com>
|
6
|
+
License-Expression: MIT
|
7
|
+
Project-URL: Homepage, https://github.com/56kyle/robust-python-demo
|
8
|
+
Project-URL: Repository, https://github.com/56kyle/robust-python-demo
|
9
|
+
Keywords: robust-python-demo
|
10
|
+
Classifier: Programming Language :: Python :: 3.9
|
11
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
12
|
+
Requires-Python: <4.0,>=3.9
|
13
|
+
Description-Content-Type: text/markdown
|
14
|
+
License-File: LICENSE
|
15
|
+
Requires-Dist: loguru>=0.7.3
|
16
|
+
Requires-Dist: platformdirs>=4.3.8
|
17
|
+
Requires-Dist: typer>=0.15.4
|
18
|
+
Requires-Dist: typing-extensions>=4.13.2
|
19
|
+
Dynamic: license-file
|
20
|
+
|
21
|
+
# robust-python-demo
|
22
|
+
|
23
|
+
robust_python_demo
|
24
|
+
|
25
|
+
---
|
26
|
+
|
27
|
+
**[📚 View Documentation](https://robust-python-demo.readthedocs.io/)** | **[🐛 Report a Bug](https://github.com/56kyle/robust-python-demo/issues)** | **[✨ Request a Feature](https://github.com/56kyle/robust-python-demo/issues)**
|
28
|
+
|
29
|
+
---
|
30
|
+
|
31
|
+
## Installation
|
32
|
+
|
33
|
+
You can install `robust_python_demo` via [pip](pip-documentation) from PyPI:
|
34
|
+
|
35
|
+
```bash
|
36
|
+
pip install robust_python_demo
|
37
|
+
```
|
38
|
+
|
39
|
+
### Installation for Development
|
40
|
+
|
41
|
+
To set up `robust_python_demo` for local development:
|
42
|
+
|
43
|
+
1. Clone the repository:
|
44
|
+
```bash
|
45
|
+
git clone https://github.com/56kyle/robust-python-demo.git
|
46
|
+
cd robust-python-demo
|
47
|
+
```
|
48
|
+
2. Install dependencies using [:term:`uv`](uv-documentation):
|
49
|
+
```bash
|
50
|
+
uv sync
|
51
|
+
```
|
52
|
+
3. Install pre-commit hooks:
|
53
|
+
```bash
|
54
|
+
uvx nox -s pre-commit -- install
|
55
|
+
```
|
56
|
+
|
57
|
+
This sets up a virtual environment and installs core, development, and quality check dependencies.
|
58
|
+
|
59
|
+
## Usage
|
60
|
+
|
61
|
+
(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.)
|
62
|
+
|
63
|
+
### As a Library
|
64
|
+
|
65
|
+
```python
|
66
|
+
# Example usage of your package as a library
|
67
|
+
# from robust_python_demo import some_function
|
68
|
+
# result = some_function()
|
69
|
+
# print(result)
|
70
|
+
```
|
71
|
+
|
72
|
+
### As a Command-Line Application
|
73
|
+
|
74
|
+
If your project defines command-line entry points in `pyproject.toml`:
|
75
|
+
|
76
|
+
```bash
|
77
|
+
# Example usage of your CLI application
|
78
|
+
# robust-python-demo --help
|
79
|
+
# robust-python-demo do-something --input file.txt
|
80
|
+
```
|
81
|
+
|
82
|
+
For detailed API documentation and CLI command references, see the **[Documentation](https://robust-python-demo.readthedocs.io/)**.
|
83
|
+
|
84
|
+
## Development Workflow
|
85
|
+
|
86
|
+
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`.
|
87
|
+
|
88
|
+
* **Run all checks (lint, typecheck, security):** `uvx nox -s check`
|
89
|
+
* **Run test suite with coverage:** `uvx nox -s test`
|
90
|
+
* **Build documentation:** `uvx nox -s docs`
|
91
|
+
* **Build package:** `uvx nox -s build`
|
92
|
+
* **See all available tasks:** `uvx nox -l`
|
93
|
+
|
94
|
+
Explore the `noxfile.py` and the project documentation for detailed information on the automated workflow.
|
95
|
+
|
96
|
+
## Contributing
|
97
|
+
|
98
|
+
(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.)
|
99
|
+
|
100
|
+
Report bugs or suggest features via the [issue tracker](https://github.com/56kyle/robust-python-demo/issues).
|
101
|
+
|
102
|
+
See [CONTRIBUTING.md](#) for contribution guidelines.
|
103
|
+
|
104
|
+
## License
|
105
|
+
|
106
|
+
Distributed under the terms of the **MIT** license. See [LICENSE](LICENSE) for details.
|
107
|
+
|
108
|
+
---
|
109
|
+
|
110
|
+
**This project was generated from the [cookiecutter-robust-python template](https://github.com/56kyle/cookiecutter-robust-python).**
|
@@ -0,0 +1,8 @@
|
|
1
|
+
robust_python_demo/__init__.py,sha256=ufppai6xLS7xpXMQYNIjtAeNIorN4iwJ8dnuusm4OX0,26
|
2
|
+
robust_python_demo/__main__.py,sha256=97JhIuf6hsJfl6vlVRWZRHAT3LhhUBs1RAXM5yf6h20,230
|
3
|
+
robust_python_demo/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
4
|
+
robust_python_demo-0.10.0.dist-info/licenses/LICENSE,sha256=rOeJI3Tl5YqiGCmK06vK7_l7ivdxjMwLENkvMUc9BHg,1067
|
5
|
+
robust_python_demo-0.10.0.dist-info/METADATA,sha256=jxJ0rBxPBGRCG6gliUEiPVdspNSnpKvPeti7yHMREGo,3768
|
6
|
+
robust_python_demo-0.10.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
7
|
+
robust_python_demo-0.10.0.dist-info/top_level.txt,sha256=H4ScHcLP0ltSuxjeGozzmnYZKLzBrZnaqVjXxA93-uw,19
|
8
|
+
robust_python_demo-0.10.0.dist-info/RECORD,,
|
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright © 2025 Kyle Oliver
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
@@ -0,0 +1 @@
|
|
1
|
+
robust_python_demo
|