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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c1e6d16c6efe498d001f2090680aa7ba85d7dde6cc8cc1b217b84aee3aa8e18 |
|
MD5 | 9efb768af545f2bae5a9d86b9ae3d2ed |
|
BLAKE2b-256 | 73cabaaf56f997a3b27ba8bf40f9915d504e5a48725afc1abd9346ed152943aa |
Close
Hashes for marcelotsvaz_python_project_template-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4589739c078475fcd92147780d3ce3b3ce5ec631aa7b81c6737098cec8c31c4f |
|
MD5 | 9d368bf07fc3870b4b87fc39cda712b2 |
|
BLAKE2b-256 | bf48205dd0c84bb90d5c092f22d7c11423841d8de87720052b02838eacb53562 |