👋
Content
⚙️
Installation
● Using github
$ pip3 install -U git+https://github.com/Animatea/python-multibar.git#master
● Using pypi
$ pip3 install -U python-multibar
⚡️
Quickstart
import random
from multibar import ProgressBar, ProgressTemplates
bar = ProgressBar(
random.randint(10, 50), # Current progress
random.randint(50, 100), # Needed progress
)
progress = bar.write_progress(**ProgressTemplates.DEFAULT)
print(f"Your progress: {progress}")
🏳️
Flags
In our project flags are used to validate and format code.
| Flag | Description | Usage |
|---|---|---|
--mypy |
Checking a project for type-hints using a config file. | python -m multibar --mypy |
--flake8 |
Checking a project for pep8 using a config file. | python -m multibar --flake8 |
--black |
Code formatting using config file. | python -m multibar --black |
--unittest |
Starts checking all tests | python -m multibar --unittest |
🔗
Useful links
📚
documentation
📦
pypi
📂
changelog
✅
TODO
- CLI support
📈
Contributing
To get more familiar with the project, you should start by reading the documentation docs. If you are already familiar with the project, then you should start by cloning our repository:
$ git clone https://github.com/Animatea/python-multibar.git
Then you create a virtual environment into which you can install any dependencies (pip3 install -r requirements.txt | pip3 install -r dev-requirements.txt). Where to begin? See open issues, thanks for your contribution to the project!
!!! Note: We try to write as clear and beautiful code as possible, so before submitting requests, format your code with black and check with mypy, flake8 (using flags).
❓
FAQ
● Bar structure
1 Feb 15, 2022
35 Dec 23, 2022
808 Jan 4, 2023
41.4k Jan 3, 2023
5.8k Jan 3, 2023
215 Dec 19, 2022
132 Dec 27, 2022
1.3k Dec 28, 2022
32 Dec 10, 2022
5 Oct 13, 2021
15 Apr 15, 2022
27 Dec 27, 2022
16 Nov 08, 2022
1 Nov 15, 2021
1 Jan 23, 2022
5 Aug 16, 2022
2 Dec 30, 2021
0 Aug 10, 2021
3.2k Jan 09, 2023
32 Jun 23, 2022
3.2k Jan 04, 2023
1 Jan 23, 2022
1 Jan 21, 2022
1 Sep 11, 2022
25 Sep 06, 2022
1 Dec 11, 2021
4 Nov 25, 2021
5 Nov 18, 2022
551 Jan 06, 2023