File tree Expand file tree Collapse file tree 1 file changed +31
-2
lines changed Expand file tree Collapse file tree 1 file changed +31
-2
lines changed Original file line number Diff line number Diff line change 1
1
[ // ] : # ( FIXME )
2
- # python-project-template
2
+
3
+ # π Python Project Template π
3
4
4
5
[ // ] : # ( FIXME )
5
6
![ example workflow] ( https://github.com/ankandrew/python-project-template/actions/workflows/main.yaml/badge.svg )
6
7
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
You canβt perform that action at this time.
0 commit comments