# 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 <cli_progress>` or `$ cli_progress` 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 -->
---
# cli_progress
[](https://codecov.io/gh/hiddify/cli_progress)
[](https://github.com/hiddify/cli_progress/actions/workflows/main.yml)
Awesome cli_progress created by hiddify
## Install it from PyPI
```bash
pip install cli_progress
```
## Usage
```py
from cli_progress import BaseClass
from cli_progress import base_function
BaseClass().base_method()
base_function()
```
```bash
$ python -m cli_progress
#or
$ cli_progress
```
## Development
Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
Raw data
{
"_id": null,
"home_page": "https://github.com/hiddify/cli_progress/",
"name": "cli-progress",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "hiddify",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0c/d1/53dad0ea08d7bd4c64eecae7a3d5cec2a60f5f89ef7ae6f7c8cf39f623fd/cli_progress-2.0.0.tar.gz",
"platform": null,
"description": "# Python Project Template\n\nA low dependency and really simple to start project template for Python Projects.\n\nSee also \n- [Flask-Project-Template](https://github.com/rochacbruno/flask-project-template/) for a full feature Flask project including database, API, admin interface, etc.\n- [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.\n\n### HOW TO USE THIS TEMPLATE\n\n> **DO NOT FORK** this is meant to be used from **[Use this template](https://github.com/rochacbruno/python-project-template/generate)** feature.\n\n1. Click on **[Use this template](https://github.com/rochacbruno/python-project-template/generate)**\n3. Give a name to your project \n (e.g. `my_awesome_project` recommendation is to use all lowercase and underscores separation for repo names.)\n3. Wait until the first run of CI finishes \n (Github Actions will process the template and commit to your new repo)\n4. If you want [codecov](https://about.codecov.io/sign-up/) Reports and Automatic Release to [PyPI](https://pypi.org) \n On the new repository `settings->secrets` add your `PYPI_API_TOKEN` and `CODECOV_TOKEN` (get the tokens on respective websites)\n4. Read the file [CONTRIBUTING.md](CONTRIBUTING.md)\n5. Then clone your new project and happy coding!\n\n> **NOTE**: **WAIT** until first CI run on github actions before cloning your new project.\n\n### What is included on this template?\n\n- \ud83d\uddbc\ufe0f Templates for starting multiple application types:\n * **Basic low dependency** Python program (default) [use this template](https://github.com/rochacbruno/python-project-template/generate)\n * **Flask** with database, admin interface, restapi and authentication [use this template](https://github.com/rochacbruno/flask-project-template/generate).\n **or Run `make init` after cloning to generate a new project based on a template.**\n- \ud83d\udce6 A basic [setup.py](setup.py) file to provide installation, packaging and distribution for your project. \n Template uses setuptools because it's the de-facto standard for Python packages, you can run `make switch-to-poetry` later if you want.\n- \ud83e\udd16 A [Makefile](Makefile) with the most useful commands to install, test, lint, format and release your project.\n- \ud83d\udcc3 Documentation structure using [mkdocs](http://www.mkdocs.org)\n- \ud83d\udcac Auto generation of change log using **gitchangelog** to keep a HISTORY.md file automatically based on your commit history on every release.\n- \ud83d\udc0b A simple [Containerfile](Containerfile) to build a container image for your project. \n `Containerfile` is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file.\n- \ud83e\uddea Testing structure using [pytest](https://docs.pytest.org/en/latest/)\n- \u2705 Code linting using [flake8](https://flake8.pycqa.org/en/latest/)\n- \ud83d\udcca Code coverage reports using [codecov](https://about.codecov.io/sign-up/)\n- \ud83d\udef3\ufe0f Automatic release to [PyPI](https://pypi.org) using [twine](https://twine.readthedocs.io/en/latest/) and github actions.\n- \ud83c\udfaf Entry points to execute your program using `python -m <cli_progress>` or `$ cli_progress` with basic CLI argument parsing.\n- \ud83d\udd04 Continuous integration using [Github Actions](.github/workflows/) with jobs to lint, test and release your project on Linux, Mac and Windows environments.\n\n> Curious about architectural decisions on this template? read [ABOUT_THIS_TEMPLATE.md](ABOUT_THIS_TEMPLATE.md) \n> 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.\n\n[\u2764\ufe0f Sponsor this project](https://github.com/sponsors/rochacbruno/)\n\n<!-- DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW -->\n\n---\n# cli_progress\n\n[](https://codecov.io/gh/hiddify/cli_progress)\n[](https://github.com/hiddify/cli_progress/actions/workflows/main.yml)\n\nAwesome cli_progress created by hiddify\n\n## Install it from PyPI\n\n```bash\npip install cli_progress\n```\n\n## Usage\n\n```py\nfrom cli_progress import BaseClass\nfrom cli_progress import base_function\n\nBaseClass().base_method()\nbase_function()\n```\n\n```bash\n$ python -m cli_progress\n#or\n$ cli_progress\n```\n\n## Development\n\nRead the [CONTRIBUTING.md](CONTRIBUTING.md) file.\n",
"bugtrack_url": null,
"license": null,
"summary": "Awesome cli_progress created by hiddify",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/hiddify/cli_progress/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b4a0886ff1b86b8fecab9d5f56053b50c2d4603655a944de3feb0f3b04a8575",
"md5": "9b3ba76f8061b893564dfdf6a42ac98a",
"sha256": "5794c30822a14ea8780407ce54e6cd3ee413b2c5c5eca8177b144ad126dc5bd7"
},
"downloads": -1,
"filename": "cli_progress-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b3ba76f8061b893564dfdf6a42ac98a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9260,
"upload_time": "2024-04-05T10:21:18",
"upload_time_iso_8601": "2024-04-05T10:21:18.004473Z",
"url": "https://files.pythonhosted.org/packages/1b/4a/0886ff1b86b8fecab9d5f56053b50c2d4603655a944de3feb0f3b04a8575/cli_progress-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0cd153dad0ea08d7bd4c64eecae7a3d5cec2a60f5f89ef7ae6f7c8cf39f623fd",
"md5": "1af1f748d071323ba6f211b9d1d443b0",
"sha256": "0f9bcbf56034430a3de3584a6063a2b9e63cd4da6c971033ba9d4f59b113b270"
},
"downloads": -1,
"filename": "cli_progress-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1af1f748d071323ba6f211b9d1d443b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10719,
"upload_time": "2024-04-05T10:21:19",
"upload_time_iso_8601": "2024-04-05T10:21:19.083670Z",
"url": "https://files.pythonhosted.org/packages/0c/d1/53dad0ea08d7bd4c64eecae7a3d5cec2a60f5f89ef7ae6f7c8cf39f623fd/cli_progress-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 10:21:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hiddify",
"github_project": "cli_progress",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "cli-progress"
}
JSON
