Template to quickly bootstrap Python projects.
Project description
๐ Python Project Template
Template to quickly bootstrap Python projects.
Uses PDM to manage dependencies, build distributions and publish to package repositories.
โจ Features
- Centralized configuration in
pyproject.toml
- Dependency management with PDM
- Testing with unittest
- Linting with Pylint
- Integration with Visual Studio Code
- Building and publishing to PyPI
- Documentation hosted on GitLab Pages
- CI/CD with GitLab
- Several useful examples
- Type hints
- Logging
- CLI
For a detailed description of all features check the documentation and the 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for marcelotsvaz_python_project_template-0.6.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5840d26939bd65eec87a45cf1d94649b768d9a0aa7a125d4b8d2ef563216c33 |
|
MD5 | e8e3a61167f7642181a89286057e32f9 |
|
BLAKE2b-256 | 672e274e8530cb9074ab67d7b4b87622c0cdc600be7e440997a4032f805087ca |
Close
Hashes for marcelotsvaz_python_project_template-0.6.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d250fd8e59e76777ea13eb982d4cc56b01fe072cfcfc24205885218ee884c7ef |
|
MD5 | e329c665c6487eb6f842ba305289c952 |
|
BLAKE2b-256 | 5041cb038660a7cffebbdff641ff2f1610bfa8a5131ccddeeca4d8546a56cd70 |