Skip to content

Commit c133cb8

Browse files
committed
Update readme
1 parent 4cd6c3f commit c133cb8

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

β€ŽREADME.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,36 @@
11
[//]: # (FIXME)
2-
# python-project-template
2+
3+
# 🐍 Python Project Template πŸš€
34

45
[//]: # (FIXME)
56
![example workflow](https://github.com/ankandrew/python-project-template/actions/workflows/main.yaml/badge.svg)
67

7-
Replace `FIXME` comments in files with project/repo specific.
8+
A modern Python project template to kickstart your next Python project with all the necessary tools and configurations.
9+
10+
## Features
11+
12+
- ✨ **Poetry**: Manage your project's dependencies and packaging with Poetry.
13+
- πŸ“ **Editorconfig**: Ensure consistent code formatting across different editors.
14+
- πŸ”§ **Formatter (Black & Isort)**: Automatically format your code using Black and Isort.
15+
- πŸ“‹ **Makefile**: Easily execute common project tasks with a Makefile.
16+
- πŸ§ͺ **Pytest**: Write and run tests for your project.
17+
- πŸ” **Mypy**: Catch and prevent type-related errors in your code.
18+
- πŸ”— **GitHub Workflow**: Automated GitHub workflow for linting, formatting, and testing your code with every push.
19+
- πŸ”§ **Modern Tools**: Use modern Python tools and best practices for development.
20+
21+
## Getting Started
22+
23+
1. Select `Use this template > Create a new repository`.
24+
25+
2. Install Poetry (if not already installed):
26+
27+
```bash
28+
pipx install poetry
29+
30+
3. Replace `FIXME` comments in files with project/repo specific.
31+
32+
### TODO
33+
34+
- [ ] Use `copier` or `cookiecutter`
35+
- [ ] Add Docker image
36+
- [ ] Add DOC generation in CI/CD

0 commit comments

Comments
Β (0)