Skip to main content

Flexible wrapper for static progressbar writing.

Project description

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
  1. Welcome to Python-Multibar
  2. Contributing
  3. Acknowledgments

Welcome to Python-Multibar!

PyPi Mypy badge Black Supported python versions

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:

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-multibar-4.0.2.tar.gz (778.5 kB view hashes)

Uploaded Source

Built Distribution

python_multibar-4.0.2-py3-none-any.whl (42.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page