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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2089e2d72698e66a16fbf5faafbc3ae11be3ce2444690909396037b3844295f4 |
|
MD5 | 8393312885c4df4441d16f7de17be5e7 |
|
BLAKE2b-256 | ed969474fb8b1a9fcdbcf149160c07e73a95e206a13698e0c60d8ec64783e94d |
Close
Hashes for marcelotsvaz_python_project_template-0.6.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3286a6e644640ba5f47e502b7132348df9c20d72860e14cdf7ef4511087bbef |
|
MD5 | e34ac9feb6bbeb426684f029e762ffa0 |
|
BLAKE2b-256 | f6d6f1823ffef93af6b0440e5bb3b4b554f20bf5b173e0abcc9da4c82a3c9af7 |