You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 26, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+10-1Lines changed: 10 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,18 @@ A low dependency and really simple to start project template for Python Projects
17
17
4. Read the file [CONTRIBUTING.md](CONTRIBUTING.md)
18
18
5. Then clone your new project and happy coding!
19
19
20
+
> **NOTE**: **WAIT** until first CI run on github actions before cloning your new project.
21
+
20
22
### What is included on this template?
21
23
24
+
- 🖼️ Templates for starting multiple application types:
25
+
***Basic low dependency** Python program (default)
26
+
***Flask** with database, admin interface, restapi and authentication.
27
+
***FastAPI** with database, authentication and Swagger UI.
28
+
***Click** CLI
29
+
***Typer** CLI
30
+
* more
31
+
**Run `make init` to generate a new project based on a template.**
22
32
- 📦 A basic [setup.py](setup.py) file to provide installation, packaging and distribution for your project.
23
33
Template uses setuptools because it's the de-facto standard for Python packages, you can run `make switch-to-poetry` later if you want.
24
34
- 🤖 A [Makefile](Makefile) with the most useful commands to install, test, lint, format and release your project.
@@ -32,7 +42,6 @@ A low dependency and really simple to start project template for Python Projects
32
42
- 🛳️ Automatic release to [PyPI](https://pypi.org) using [twine](https://twine.readthedocs.io/en/latest/) and github actions.
33
43
- 🎯 Entry points to execute your program using `python -m <project_name>` or `$ project_name` with basic CLI argument parsing.
34
44
- 🔄 Continuous integration using [Github Actions](.github/workflows/) with jobs to lint, test and release your project on Linux, Mac and Windows environments.
35
-
- 🖼️ An easy way to add a flask, fastapi, click or Typer application to your project with `make init`.
36
45
37
46
> Curious about architectural decisions on this template? read [ABOUT_THIS_TEMPLATE.md](ABOUT_THIS_TEMPLATE.md)
38
47
> If you want to contribute to this template please open an [issue](https://github.com/rochacbruno/python-project-template/issues) or fork and send a PULL REQUEST.
0 commit comments