Metadata-Version: 2.1
Name: marcelotsvaz-python-project-template
Version: 0.6.3
Summary: Template to quickly bootstrap Python projects.
Home-page: https://marcelotsvaz.gitlab.io/python-project-template/
Author-Email: Marcelo Vaz <marcelotsvaz@gmail.com>
License: 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/>
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
Project-URL: Homepage, https://marcelotsvaz.gitlab.io/python-project-template/
Project-URL: Documentation, https://marcelotsvaz.gitlab.io/python-project-template/documentation/
Project-URL: Issues, https://gitlab.com/marcelotsvaz/python-project-template/-/issues
Project-URL: Source, https://gitlab.com/marcelotsvaz/python-project-template
Requires-Python: >=3.11
Requires-Dist: django>=4.2.5
Requires-Dist: jsons>=1.6.3; extra == "json"
Provides-Extra: json
Description-Content-Type: text/markdown

# 🐍 Python Project Template
Template to quickly bootstrap Python projects.

Uses [PDM](https://pdm.fming.dev/) to manage dependencies, build distributions and publish to package repositories.


## ✨ Features
- Centralized configuration in `pyproject.toml`
- Dependency management with [PDM](https://pdm.fming.dev/)
- Testing with [unittest](https://docs.python.org/3/library/unittest.html)
- Linting with [Pylint](https://github.com/pylint-dev/pylint)
- Integration with [Visual Studio Code](https://code.visualstudio.com/)
- Building and publishing to [PyPI](https://pypi.org/)
- Documentation hosted on [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/)
- CI/CD with [GitLab](https://docs.gitlab.com/ee/ci/)
- Several useful examples
	- Type hints
	- Logging
	- CLI

For a detailed description of all features check the [documentation](https://marcelotsvaz.gitlab.io/python-project-template/documentation/) and the [examples](examples/).


## 📂 Project Structure
```
📂 Python Project Template
├─ 📁 .staging              Build artifacts and other ignored files
├─ 📁 .vscode               VS Code configuration
├─ 📁 build                 Build scripts and local PDM plugins
├─ 📂 doc                   Documentation
│  ├─ 📁 documentation      Sources for TODO documentation
│  └─ 📁 homepage           Project homepage on GitLab Pages
├─ 📁 examples              Examples
├─ 📁 project_template      Main package
├─ 📁 tests                 Tests for the main package
├─ 🔶 .gitignore            Git ignored files
├─ 🦊 .gitlab-ci.yml        GitLab CI/CD configuration
├─ 🔒 pdm.lock              Dependency lock file
├─ ⚙️ pyproject.toml        Project metadata and tool configuration
├─ 📄 readme.md             Readme (this file)
└─ 📜 unlicense.txt         License
```


## Contributing
TODO: Contributing.