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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70364df3da6a0480c837c5850d43d2341ebfb6400f923ce166bac9e2910c9440 |
|
MD5 | 872dec02988043a1d9716eda996814ee |
|
BLAKE2b-256 | c6b340ebfe6d6a4b2c3076b11ca93336a890a204a64b16e9e029e5fbf350128e |
Close
Hashes for marcelotsvaz_python_project_template-0.6.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 314d31b14e22a3d5000895c7fd2bc1778484b85fbacaf4caf59eafcd6a2ed37f |
|
MD5 | 950345a4a493b2d98a6b39bafd728e8e |
|
BLAKE2b-256 | 47dd5e790c7f867b3afbcbd88ac6273b3524af81da85b152c1ffcee63eaad4cf |