Skip to content

Commit 5335ea1

Browse files
committed
docs: update project description in README.md file
Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>
1 parent f34e8b9 commit 5335ea1

1 file changed

Lines changed: 7 additions & 11 deletions

File tree

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
11
# Python Starter
22

3-
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.
3+
A minimalist template for starting a new [Python](https://www.python.org/) project.
44

5-
## Key Features
6-
7-
- Organized file structure for Python projects, featuring a sample `pyproject.toml`, a sample module, and associated testing files.
8-
- Project and dependency management with [uv](https://docs.astral.sh/uv/).
9-
- Code formatting and linting with [Ruff](https://github.com/astral-sh/ruff), leveraging all recommended rules for enhanced code quality.
10-
- Testing framework powered by [Pytest](https://docs.pytest.org/en/7.4.x/), complete with support for test coverage checks.
11-
- [GitHub Actions](https://github.com/features/actions) support with multiple workflows for continuous integration (CI) and continuous delivery (CD).
12-
- Automated dependency update checks with [Dependabot](https://docs.github.com/en/code-security/dependabot).
5+
This template provides a basic Python project containing an example package with built-in support for formatting, linting, testing, and continuous integration.
136

14-
## Usage
7+
## Key Features
158

16-
Refer to [this wiki](https://github.com/threeal/python-starter/wiki) for information on how to use this template.
9+
- Uses [uv](https://docs.astral.sh/uv/) as the package manager.
10+
- Supports formatting and linting with [Ruff](https://github.com/astral-sh/ruff), and testing with [Pytest](https://docs.pytest.org/en/7.4.x/).
11+
- Fixes formatting and linting during pre-commit hooks using [Lefthook](https://lefthook.dev/).
12+
- Preconfigured workflows for [Dependabot](https://docs.github.com/en/code-security/dependabot) and [GitHub Actions](https://github.com/features/actions).

0 commit comments

Comments
 (0)