python-template-project 0.1.0__py3-none-any.whl

python_template_project-0.1.0.dist-info/METADATA

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: python-template-project
+Version: 0.1.0
+Summary: Feature-rich Python project template designed for robustness and ease of use.
+Author: pamagister
+License-File: LICENSE
+Requires-Python: <3.12,>=3.10
+Requires-Dist: gpxpy>=1.6.2
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: srtm-py>=0.3.7
+Provides-Extra: dev
+Requires-Dist: black>=25.1.0; extra == 'dev'
+Requires-Dist: coverage>=7.8.2; extra == 'dev'
+Requires-Dist: flake8>=7.2.0; extra == 'dev'
+Requires-Dist: gitchangelog>=3.0.4; extra == 'dev'
+Requires-Dist: isort>=6.0.1; extra == 'dev'
+Requires-Dist: mypy>=1.16.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.2.0; extra == 'dev'
+Requires-Dist: pyinstaller>=5.8; extra == 'dev'
+Requires-Dist: pytest-cov>=6.1.1; extra == 'dev'
+Requires-Dist: pytest-mock>=3.14.1; extra == 'dev'
+Requires-Dist: pytest>=8.4.0; extra == 'dev'
+Requires-Dist: ruff>=0.11.13; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-awesome-nav>=2.6.1; extra == 'docs'
+Requires-Dist: mkdocs>=1.6.1; extra == 'docs'
+Requires-Dist: pygments>=2.19.1; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# Welcome to python-template-project
+
+A feature-rich Python project template with with auto-generated CLI, GUI and parameterized configuration.
+
+[![Github CI Status](https://github.com/pamagister/python-template-project/actions/workflows/main.yml/badge.svg)](https://github.com/pamagister/python-template-project/actions)
+[![GitHub release](https://img.shields.io/github/v/release/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/releases)
+[![Read the Docs](https://readthedocs.org/projects/python-template-project/badge/?version=stable)](https://python-template-project.readthedocs.io/en/stable/)
+[![License](https://img.shields.io/github/license/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/blob/main/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/pamagister/python-template-project)](https://github.com/pamagister/python-template-project/issues)
+[![PyPI](https://img.shields.io/pypi/v/python-template-project)](https://pypi.org/project/python-template-project/)
+
+
+This template provides a solid foundation for your next Python project, incorporating best practices for testing, automation, and distribution. It streamlines the development process with a comprehensive set of pre-configured tools and workflows, allowing you to focus on writing code.
+
+
+## Feature overview
+
+* **Testing:** Unit testing setup with `pytest`.
+* **CI/CD:** GitHub Actions for automated builds (Windows, macOS), unit tests, and code checks.
+* **Code Formatting:** Pre-commit hook with the *black* auto-formatter to ensure consistent code style.
+* **Automated Builds:** GitHub pipeline for automatically building a Windows executable and a macOS installer.
+* **Package Management:** Utilizes *uv*, an extremely fast Python package manager, with dependencies managed in `pyproject.toml`.
+* **Parameter-Driven Automation:**
+    * Automatic generation of a configuration file from parameter definitions.
+    * Automatic generation of a Command-Line Interface (CLI) from the same parameters.
+    * Automatic generation of CLI API documentation.
+* **Documentation:** Configuration for publishing documentation on Read the Docs.
+* **Workflow Automation:** A `Makefile` is included to simplify and automate common development tasks.
+* **Minimalist GUI:** Comes with a basic GUI based on [tkinker](https://tkdocs.com/tutorial/index.html) that includes an auto-generated settings menu based on your defined parameters.
+
+## Getting started
+
+1. **Create** a new [github repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository).
+2. **Clone** [github repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the into your local file system.
+    ```bash
+    git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
+    ```
+4. **Install** [uv package and project manager](https://docs.astral.sh/uv/getting-started/installation/)
+    ```bash
+    pip install uv
+    ```
+5. **Generate** [a sample project](https://docs.astral.sh/uv/guides/projects/#creating-a-new-project) with uv
+6. Add and **push** the artifacts to your github repository
+    ```bash
+    git push
+    ```
+8. Copy the content of this repository into your repository
+
+## Troubleshooting
+
+### Problems with release pipeline
+
+If you get this error below:
+```bash
+/home/runner/work/_temp/xxxx_xxx.sh: line 1: .github/release_message.sh: Permission denied
+```
+
+You have to run these commands in your IDE Terminal or the git bash and then push the changes.
+```bash
+git update-index --chmod=+x ./.github/release_message.sh
+```
+

python_template_project-0.1.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+python_template_project/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_template_project/__main__.py,sha256=JS28LiHoU9Xo4c_RvyLBTDKHqdZRRytJLj6qyrg26mQ,195
+python_template_project/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_template_project/cli/__main__.py,sha256=qnGkoNNbhnvLTA24X8YTEDxRqDbNEAzgjp9Ki_JYIhs,184
+python_template_project/cli/cli.py,sha256=RvoYKJDjP-PYlX4m5xFnUsuHVJw_3-AgpQwOxhPAH5g,6974
+python_template_project/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_template_project/config/config.py,sha256=bVqFIY8oScfhv2LpjcNoyiGqrIyVz5Ri3VjVnem1ZPA,17924
+python_template_project/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_template_project/core/base.py,sha256=0qLUlpc9zhbBgo_PGH-KsGHoNcmGbNPKIuLNpa9mMGI,15196
+python_template_project/core/logging.py,sha256=D99ZAXY9KZvmV7oVlAy3S3fuDf9G7vHvIk277xB7068,6944
+python_template_project/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_template_project/gui/__main__.py,sha256=5AaiBxNCAKWcuSQFcQ_lsEQfEsXm6BA5-i5MScdf30c,184
+python_template_project/gui/gui.py,sha256=qJ9SawFywwT7ffPndTzhuLEu2KkzjBspmSccAXgUC2k,21725
+python_template_project-0.1.0.dist-info/METADATA,sha256=8bZTpByUoxmOQKW8XyTedN137uHRkBkZe4j6EtQUQZA,4808
+python_template_project-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_template_project-0.1.0.dist-info/entry_points.txt,sha256=LmgMiqxIVRdD7gkktVBBR0CR4AhkugqlgifuglkPhtI,148
+python_template_project-0.1.0.dist-info/licenses/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+python_template_project-0.1.0.dist-info/RECORD,,

python_template_project-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

python_template_project-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+python-template-project = python_template_project.cli.cli:main
+python-template-project-gui = python_template_project.gui.gui:main

python_template_project-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>