generated from rochacbruno/python-project-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bed2fab
commit c4c9877
Showing
1 changed file
with
6 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,9 @@ | ||
|
|
||
| # Python Project Template | ||
| # HiddifyPanel Bot | ||
|
|
||
| A low dependency and really simple to start project template for Python Projects. | ||
| ## 🌎 Translations | ||
|
|
||
| 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 <hiddifypanel_bot>` or `$ hiddifypanel_bot` 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/) | ||
|
|
||
| <!-- DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW --> | ||
|
|
||
| --- | ||
| # hiddifypanel_bot | ||
|
|
||
| [](https://codecov.io/gh/hiddify/hiddifypanel_bot) | ||
| [](https://github.com/hiddify/hiddifypanel_bot/actions/workflows/main.yml) | ||
|
|
||
| Awesome hiddifypanel_bot created by hiddify | ||
|
|
||
| ## Install it from PyPI | ||
|
|
||
| ```bash | ||
| pip install hiddifypanel_bot | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```py | ||
| from hiddifypanel_bot import BaseClass | ||
| from hiddifypanel_bot import base_function | ||
|
|
||
| BaseClass().base_method() | ||
| base_function() | ||
| ``` | ||
|
|
||
| ```bash | ||
| $ python -m hiddifypanel_bot | ||
| #or | ||
| $ hiddifypanel_bot | ||
| ``` | ||
|
|
||
| ## Development | ||
|
|
||
| Read the [CONTRIBUTING.md](CONTRIBUTING.md) file. | ||
| <div align=center> | ||
|
|
||
| [](https://inlang.com/editor/github.com/hiddify/hiddifypanel_bot?ref=badge) | ||
| </div> |