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.7.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9029b6ed44c09afe7d0acb9e84371849346d546c5603576b05ebeb94a8b0b916 |
|
MD5 | d1f1f864dadaeaece578dde4ab03c1a3 |
|
BLAKE2b-256 | 75c1d5f5a72a9b82069c13b2b65f5aa1323ccf7715902a6b15f7873dace0fb80 |
Close
Hashes for marcelotsvaz_python_project_template-0.7.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0549c9dffd0c908b9d24acc0786f7ce56e521437a5a61c0e1ce53844f3a7cc0c |
|
MD5 | 2adb9d4ceedda52c1a6427d86a43d63e |
|
BLAKE2b-256 | b0eb41906e378bf9e7b88c65d39221566dc983cce6ab660a3ec70cdd3783de2c |