diff --git a/README.md b/README.md index a083ab2..ee545c8 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,3 @@ - -# Python Project Template - -A low dependency and really simple to start project template for Python Projects. - -See also -- [Flask-Project-Template](https://git.disi.dev/Templates/Flask/) for a full feature Flask project including database, API, admin interface, etc. - -### HOW TO USE THIS TEMPLATE - -1. Create a new repository from this template and choose a name for your project - (e.g. `my_awesome_project` - recommendation is to use all lowercase and underscores separation for repo names.) -2. Wait until the first run of CI finishes (Gitea Actions will process the template and commit to your new repo) -3. Read the file [CONTRIBUTING.md](CONTRIBUTING.md) -4. Then clone your new project and happy coding! - -> **NOTE**: **WAIT** until first CI run on gitea actions before cloning your new project. - -### What is included on this template? - -- ๐Ÿ–ผ๏ธ Templates for starting multiple application types: - **Run `make init` after cloning to generate a new project based on a template.** -- ๐Ÿ“ฆ A basic [setup.py](setup.py) file to provide installation, packaging and distribution for your project. - Template uses setuptools because it's the de-facto standard for Python packages, you can run `make switch-to-poetry` later if you want. -- ๐Ÿค– A [Makefile](Makefile) with the most useful commands to install, test, lint, format and release your project. -- ๐Ÿ“ƒ Documentation structure using [mkdocs](http://www.mkdocs.org) -- ๐Ÿ’ฌ Auto generation of change log using **gitchangelog** to keep a HISTORY.md file automatically based on your commit history on every release. -- ๐Ÿ‹ A simple [Containerfile](Containerfile) to build a container image for your project. - `Containerfile` is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file. -- ๐Ÿงช Testing structure using [pytest](https://docs.pytest.org/en/latest/) -- โœ… Code linting using [flake8](https://flake8.pycqa.org/en/latest/) -- ๐ŸŽฏ Entry points to execute your program using `python -m ` or `$ project_name` with basic CLI argument parsing. -- ๐Ÿ”„ Continuous integration using [Gitea Actions](.gitea/workflows/) with jobs to lint, test and release your project on Linux, Mac and Windows environments. - -> Curious about architectural decisions on this template? read [ABOUT_THIS_TEMPLATE.md](ABOUT_THIS_TEMPLATE.md) - - - ---- # project_name project_description