Skip to content

Commit 326a5f6

Browse files
committed
Update docs/index.md
1 parent 2c90bd9 commit 326a5f6

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

docs/index.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Python Template
2+
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
4+
[![Test](https://github.com/leynier/python-template/workflows/CI/badge.svg)](https://github.com/leynier/python-template/actions?query=workflow%3ACI)
5+
[![codecov](https://codecov.io/gh/leynier/python-template/branch/main/graph/badge.svg?token=Z1MEEL3EAB)](https://codecov.io/gh/leynier/python-template)
6+
[![Version](https://img.shields.io/pypi/v/python-template?color=%2334D058&label=Version)](https://pypi.org/project/python-template)
7+
[![Last commit](https://img.shields.io/github/last-commit/leynier/python-template.svg?style=flat)](https://github.com/leynier/python-template/commits)
8+
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/leynier/python-template)](https://github.com/leynier/python-template/commits)
9+
[![Github Stars](https://img.shields.io/github/stars/leynier/python-template?style=flat&logo=github)](https://github.com/leynier/python-template/stargazers)
10+
[![Github Forks](https://img.shields.io/github/forks/leynier/python-template?style=flat&logo=github)](https://github.com/leynier/python-template/network/members)
11+
[![Github Watchers](https://img.shields.io/github/watchers/leynier/python-template?style=flat&logo=github)](https://github.com/leynier/python-template)
12+
[![Website](https://img.shields.io/website?up_message=online&url=https%3A%2F%2Fleynier.github.io/python-template)](https://leynier.github.io/python-template)
13+
[![GitHub contributors](https://img.shields.io/github/contributors/leynier/python-template)](https://github.com/leynier/python-template/graphs/contributors)
14+
15+
Python template with CI/CD ready for production
16+
17+
## Features
18+
19+
- Management of dependencies with [Poetry](https://python-poetry.org)
20+
- Generation of documentation based on Markdown with [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material)
21+
- Automatic check of the pythonic style with [flake8](https://flake8.pycqa.org), [black](https://black.readthedocs.io) and [isort](https://pycqa.github.io/isort)
22+
- Automatic code checking with [pytest](https://pytest.org)
23+
- Automatic code report with [codecov](https://codecov.io/)
24+
- Automatic publish to [GitHub Releases](https://docs.github.com/es/free-pro-team@latest/github/administering-a-repository/releasing-projects-on-github)
25+
- Automatic publish to [PyPI](https://pypi.org)
26+
- Automatic dependency update check with [dependabot](https://github.com/dependabot)
27+
28+
> All of the above via [GitHub Actions](https://github.com/features/actions) and [GitHub Pages](https://pages.github.com)

0 commit comments

Comments
 (0)