Skip to content

Commit 8527149

Browse files
authored
chore: merge pull request #40 from threeal/update-readme
Update `README.md` file
2 parents f0f1962 + 8b93095 commit 8527149

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Python Starter
22

3+
[![version](https://img.shields.io/github/v/release/threeal/python-starter?style=flat-square)](https://github.com/threeal/python-starter/releases)
4+
[![license](https://img.shields.io/github/license/threeal/python-starter?style=flat-square)](./LICENSE)
35
[![build status](https://img.shields.io/github/actions/workflow/status/threeal/python-starter/ci.yaml?branch=main&style=flat-square)](https://github.com/threeal/python-starter/actions/workflows/ci.yaml)
46

5-
Kickstart your [Python](https://www.python.org/) project using this [GitHub repository template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
7+
The Python Starter is a [GitHub repository template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) that provides a minimalistic boilerplate to kickstart your [Python](https://www.python.org/) project. This template offers a streamlined foundation, complete with predefined file structures, essential tools, and recommended settings, ensuring a swift and efficient start to your Python development journey.
8+
9+
## Key Features
10+
11+
- [Poetry](https://python-poetry.org/) for project management.
12+
- [Pytest](https://docs.pytest.org/en/7.4.x/) for testing and coverage checks.
13+
- Consistent code formatting with [Black](https://black.readthedocs.io/en/stable/).
14+
- Import sorting with [isort](https://pycqa.github.io/isort/).
15+
- Static analysis and linting with [Flake8](https://flake8.pycqa.org/en/latest/).
16+
- Preconfigured [GitHub Actions](https://github.com/features/actions) workflow for CI.
17+
- [Dependabot](https://docs.github.com/en/code-security/dependabot) support for dependency updates.
18+
19+
## Usage
20+
21+
Refer to [this wiki](https://github.com/threeal/python-starter/wiki) for information on how to use this template.

0 commit comments

Comments
 (0)