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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ddebb04a2212f3da19e966317eaf5a0ee2e5d426569e176c01f29262f98a9670 |
|
MD5 | c1d2313fc62f57a8d571a695e5206dd5 |
|
BLAKE2b-256 | 2e0f2dc990180a265ba9761387f361386c426063bd86d2c78c24fc8816075ed9 |
Close
Hashes for marcelotsvaz_python_project_template-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aafc0bf77e039ad437a36a7b6c85fdf89e3558ee35fb4ed45d6bf4de34f5e4ff |
|
MD5 | 8f7a5fc126fcf53abbcdf54ab9f9414c |
|
BLAKE2b-256 | 9de1ac54d1bd79c4f5db95f569a98545b24c040eb8cc00876c5f2a1058ea9135 |