From 7b2c8480cd270d8565dfb2cadf4b341cbe69777d Mon Sep 17 00:00:00 2001 From: Anton <124515572+RoundRonin@users.noreply.github.com> Date: Sun, 31 Mar 2024 00:32:37 +0300 Subject: [PATCH] Update README.md --- README.md | 53 ----------------------------------------------------- 1 file changed, 53 deletions(-) diff --git a/README.md b/README.md index 1df5d2d..373987c 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,3 @@ - -# Python Project Template - -A low dependency and really simple to start project template for Python Projects. - -See also -- [Flask-Project-Template](https://github.com/rochacbruno/flask-project-template/) for a full feature Flask project including database, API, admin interface, etc. -- [FastAPI-Project-Template](https://github.com/rochacbruno/fastapi-project-template/) The base to start an openapi project featuring: SQLModel, Typer, FastAPI, JWT Token Auth, Interactive Shell, Management Commands. - -### HOW TO USE THIS TEMPLATE - -> **DO NOT FORK** this is meant to be used from **[Use this template](https://github.com/rochacbruno/python-project-template/generate)** feature. - -1. Click on **[Use this template](https://github.com/rochacbruno/python-project-template/generate)** -3. Give a name to your project - (e.g. `my_awesome_project` recommendation is to use all lowercase and underscores separation for repo names.) -3. Wait until the first run of CI finishes - (Github Actions will process the template and commit to your new repo) -4. If you want [codecov](https://about.codecov.io/sign-up/) Reports and Automatic Release to [PyPI](https://pypi.org) - On the new repository `settings->secrets` add your `PYPI_API_TOKEN` and `CODECOV_TOKEN` (get the tokens on respective websites) -4. Read the file [CONTRIBUTING.md](CONTRIBUTING.md) -5. Then clone your new project and happy coding! - -> **NOTE**: **WAIT** until first CI run on github actions before cloning your new project. - -### What is included on this template? - -- ๐Ÿ–ผ๏ธ Templates for starting multiple application types: - * **Basic low dependency** Python program (default) [use this template](https://github.com/rochacbruno/python-project-template/generate) - * **Flask** with database, admin interface, restapi and authentication [use this template](https://github.com/rochacbruno/flask-project-template/generate). - **or 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/) -- ๐Ÿ“Š Code coverage reports using [codecov](https://about.codecov.io/sign-up/) -- ๐Ÿ›ณ๏ธ Automatic release to [PyPI](https://pypi.org) using [twine](https://twine.readthedocs.io/en/latest/) and github actions. -- ๐ŸŽฏ Entry points to execute your program using `python -m ` or `$ image_recognition` with basic CLI argument parsing. -- ๐Ÿ”„ Continuous integration using [Github Actions](.github/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) -> 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. - -[โค๏ธ Sponsor this project](https://github.com/sponsors/rochacbruno/) - - - ---- # image_recognition [![codecov](https://codecov.io/gh/RoundRonin/Image-recognition/branch/main/graph/badge.svg?token=Image-recognition_token_here)](https://codecov.io/gh/RoundRonin/Image-recognition)