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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 169f72141111f6391a255b7e637f7664d12e049ac0d83208a02b74a4f9cee589 |
|
MD5 | 88046a479c044389698c6765f6ddf68c |
|
BLAKE2b-256 | 1b0d3a38ac2f470866b14489f211c2d0b4e93208753ce64eb6e111e1f6b0176c |
Close
Hashes for marcelotsvaz_python_project_template-0.6.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e4cdf53048c8fd93ee0f57c077b9fd21aaa07915ea9f7fbf569a7ffbbe21f52 |
|
MD5 | c5bf70946ff2a4133e275744618332e5 |
|
BLAKE2b-256 | bded6d7a1fb08e0f667f916b88aa6311da5b1848b869db07598558d4bb0fd5df |