👋
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
13 Sep 23, 2021
79 Dec 02, 2022
2 Oct 24, 2021
73 Oct 12, 2022
5 Dec 15, 2021
25 Dec 22, 2022
1 Jan 23, 2022
6.7k Jan 08, 2023
4 Aug 09, 2022
7 May 09, 2022
41 Dec 12, 2022
21 Jan 03, 2023
14 Sep 11, 2022
4.2k Jan 03, 2023
2 Jul 15, 2022
133 Nov 30, 2022
2 Dec 06, 2021
1 Oct 24, 2021
222 Jan 03, 2023