python-multibar 4.0.2

Description:

pythonmultibar 4.0.2

Project: python-multibar

License: Apache 2.0

About: Tool for static progress bars writing.

OS: Independent

Python: 3.9+

Typing: Typed

Topic: Utilities



Documentation
·
Report Bug
·
Request Feature







Table of Contents


Welcome to Python-Multibar

Installation
Quickstart
Documentation
Examples



Contributing


Acknowledgments



Welcome to Python-Multibar!





Installation
# Unix/macOS users should use
$ python -m pip install -U python-multibar

# Windows users should use
$ py -m pip install -U python-multibar

Quickstart
>>> import multibar

>>> writer = multibar.ProgressbarWriter()
>>> progressbar = writer.write(10, 100)
# Using __str__() method, we get a progressbar
# with a basic signature.
Out: '+-----'

# Writer returns progressbar object.
>>> type(progressbar)
Out: <class 'multibar.impl.progressbars.Progressbar'>

Documentation
You can access the documentation by clicking on the following link:

animatea.github.io/python-multibar

Examples
Some more of the features of python-multibar are in the project examples.


Python-Multibar Examples


Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request


NOTE: before creating a pull request, you first need to install the project's dependencies:

pip3 install -r dev-requirements.txt -r requirements.txt

Then go to the root directory of the project ...\python-multibar> and start all nox pipelines using the nox command.
If all sessions are completed successfully, then feel free to create a pull request. Thanks for your PR's!


Acknowledgments

Choose an Open Source License
Img Shields
GitHub Pages
Python
Python Community
MkDocs
MkDocs Material