marcelotsvaz-python-project-template 0.6.7

Template to quickly bootstrap Python projects.

🐍 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.