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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1ee0a6c1026edc7f2e5d43157f3275987bdd4ca950a30a95f9ab2fc0a342761 |
|
MD5 | e250260b0aca76ddae891c692df324d7 |
|
BLAKE2b-256 | a4585f0ba5fd5558dcd08252e292a70d2b54c7fc9835c84b9c7dc23ad106f607 |
Close
Hashes for marcelotsvaz_python_project_template-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e80374ddd2a050d649b061c8f86b56d8b98fda864227d3a99f791471842a40e |
|
MD5 | 631ac35ec2b8411f02d5bbc3bfdce531 |
|
BLAKE2b-256 | d168c79f2fa83283df8997ea7a6b175e33ca3144fe3976b44d6dfa31e80065b8 |