Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marcelotsvaz/python-project-template

Template to quickly bootstrap Python projects.
https://github.com/marcelotsvaz/python-project-template

python template-project

Last synced: about 1 month ago
JSON representation

Template to quickly bootstrap Python projects.

Host: GitHub
URL: https://github.com/marcelotsvaz/python-project-template
Owner: Marcelotsvaz
License: unlicense
Created: 2023-09-21T22:38:29.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-05-30T16:58:14.000Z (7 months ago)
Last Synced: 2024-05-30T20:03:15.031Z (7 months ago)
Topics: python, template-project
Language: Python
Homepage: https://gitlab.com/marcelotsvaz/python-project-template
Size: 159 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

        [![Gitlab pipeline status](https://img.shields.io/gitlab/pipeline-status/vaz-projects%2Fpython-project-template?logo=gitlab&label=Build)](https://gitlab.com/vaz-projects/python-project-template/-/pipelines/latest)

[![Code coverage](https://img.shields.io/gitlab/pipeline-coverage/vaz-projects%2Fpython-project-template?branch=main&label=Coverage)](https://gitlab.com/vaz-projects/python-project-template/-/pipelines/latest)

[![GitLab release](https://img.shields.io/gitlab/v/release/vaz-projects%2Fpython-project-template?logo=gitlab&label=Release)](https://gitlab.com/vaz-projects/python-project-template/-/releases/permalink/latest)

[![PyPI package](https://img.shields.io/pypi/v/marcelotsvaz-python-project-template?logo=python&logoColor=%23CCCCCC&label=PyPI)](https://pypi.org/project/marcelotsvaz-python-project-template/)

[![Renovate](https://img.shields.io/badge/Renovate-enabled-green?logo=renovatebot&logoColor=%23007fa0)](https://gitlab.com/vaz-projects/python-project-template/-/issues/1)

# 🐍 Python Project Template

Template to quickly bootstrap Python projects.

Uses [PDM](https://pdm.fming.dev/) to manage dependencies, build distributions and publish to package repositories.

## ✨ Features

- Centralized configuration in `pyproject.toml`

- Dependency management with [PDM](https://pdm.fming.dev/)

- Testing with [unittest](https://docs.python.org/3/library/unittest.html)

- Linting with [Pylint](https://github.com/pylint-dev/pylint)

- Integration with [Visual Studio Code](https://code.visualstudio.com/)

- Building and publishing to [PyPI](https://pypi.org/)

- Documentation hosted on [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/)

- CI/CD with [GitLab](https://docs.gitlab.com/ee/ci/)

- Several useful examples

	- Type hints

	- Logging

	- CLI

For a detailed description of all features check the [documentation](https://vaz-projects.gitlab.io/python-project-template/).

## Contributing

TODO: Contributing.