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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b8e4cbdde9204e0e8155b35cfbcdf4d0dc8527d31d57b7a4069d09abe99d882 |
|
MD5 | 2da1e145bfaf6d4af5446d0852ea2f9d |
|
BLAKE2b-256 | 82e9d4c09210701a8d9f04b11aa7bc10d3b36deb01f991806a925f6da0dd15d4 |
Close
Hashes for marcelotsvaz_python_project_template-0.6.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdf93390303605fa0a887c847a03299bcacb2452dfa5ccd481c1410a2eb82d8a |
|
MD5 | de47916a15b2235df780f961d6cf0b1b |
|
BLAKE2b-256 | 2dca3b60c1b85998186cdf136a4134046f901a8c1e54506f626776f48b1998b0 |