Multifunctional library for creating progress bars.

Overview

Pypi Versions Mypy PEP8 Code style: black TOTAL LINES Build

πŸ‘‹ 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

click here

πŸ“¦ pypi

click here

πŸ“‚ changelog

click here

βœ… 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

Bar image

You might also like...
A CLI for creating styled-components for React projects quickly

new-component Ian Cleary (iancleary) Description Welcome! This is a CLI for creating styled-components for React projects quickly. Note: I've rewrote

slipit is a command line utility for creating archives with path traversal elements.

slipit is a command line utility for creating archives with path traversal elements. It is basically a successor of the famous evilarc utility with an extended feature set and improved base functionality.

Library and command-line utility for rendering projects templates.
Library and command-line utility for rendering projects templates.

A library for rendering project templates. Works with local paths and git URLs. Your project can include any file and Copier can dynamically replace v

Rich is a Python library for rich text and beautiful formatting in the terminal.
Rich is a Python library for rich text and beautiful formatting in the terminal.

The Rich API makes it easy to add color and style to terminal output. Rich can also render pretty tables, progress bars, markdown, syntax highlighted source code, tracebacks, and more β€” out of the box.

Write Django management command using the click CLI library

Django Click Project information: Automated code metrics: django-click is a library to easily write Django management commands using the click command

πŸ–οΈThis is a feature-complete clone of the awesome Chalk (JavaScript) library.
πŸ–οΈThis is a feature-complete clone of the awesome Chalk (JavaScript) library.

Terminal string styling done right This is a feature-complete clone of the awesome Chalk (JavaScript) library. All credits go to Sindre Sorhus. Highli

A command line tool (and Python library) for archiving Twitter JSON

A command line tool (and Python library) for archiving Twitter JSON

A powerful Minecraft command library.
A powerful Minecraft command library.

Mecha A powerful Minecraft command library. from mecha import Mecha

Comments
  • Fixing broken docs link in README

    Fixing broken docs link in README

    It would also be really nice to have screen shots of the different status bars in the docs or (better) right in the README. Right now I'd be required to install it and run an example, and this is unlikely.

    opened by vsoch 1
Releases(#4.0.2)
  • #4.0.2(Oct 6, 2022)

    Python-Multibar 4.0.2 (06.10.2022)

    Features

    • Add multibar.INPUT_VALUES_CONTRACT (alias to multibar.WRITE_PROGRESS_CONTRACT)

    Documentation changes

    • Add Raises section to multibar.ProgressbarClient.get_progress()
    • Add Showcase page with quick examples to github.io site
    Source code(tar.gz)
    Source code(zip)
Animefetch is an anime command-line system information tool written in python

Animefetch - v0.0.3 An anime command-line system information tool written in python. Description Animefetch is an anime command-line system informatio

Thadeuks 6 Jun 17, 2022
CLI to show end-of-life dates for tools and technologies.

Python 3.9+ interface to endoflife.date to show end-of-life dates for tools and technologies.

Hugo van Kemenade 32 Jan 06, 2023
Apple Silicon 'top' CLI

asitop pip install asitop What A nvtop/htop style/inspired command line tool for Apple Silicon (aka M1) Macs. Note that it requires sudo to run due to

Timothy Liu 1.2k Dec 31, 2022
split-manga-pages: a command line utility written in Python that converts your double-page layout manga to single-page layout.

split-manga-pages split-manga-pages is a command line utility written in Python that converts your double-page layout manga (or any images in double p

Christoffer Aakre 3 May 24, 2022
Declarative CLIs with argparse and dataclasses

argparse_dataclass Declarative CLIs with argparse and dataclasses. Features Features marked with a βœ“ are currently implemented; features marked with a

Mike DePalatis 29 Dec 06, 2022
Postgres CLI with autocompletion and syntax highlighting

A REPL for Postgres This is a postgres client that does auto-completion and syntax highlighting. Home Page: http://pgcli.com MySQL Equivalent: http://

dbcli 10.8k Jan 02, 2023
A CLI tool for creating disposable environments.

dispenv - Disposable Python Environments ⚠️ WIP Need to make an environment to work on a GitHub issue? Want to try out a new package and not leave the

Peter Baumgartner 3 Mar 14, 2022
Install python modules from pypi from a previous date in history

pip-rewind is a command-line tool that can rewind pypi module versions (given as command-line arguments or read from a requirements.txt file) to a previous date in time.

Amar Paul 4 Jul 03, 2021
CLI tool for typescript tasks & migrations

typed CLI tool for typescript tasks & migrations Installation Usage $ typed --list Subcommands: bootstrap πŸ”¨ Bootstrap your environment for TypeS

Lob 1 Nov 15, 2021
Tarstats - A simple Python commandline application that collects statistics about tarfiles

A simple Python commandline application that collects statistics about tarfiles.

Kristian Koehntopp 13 Feb 20, 2022
This CLI give the possibility to do a queries in Star Wars API and returns a JSON in a terminal.

Star Wars CLI (swcli) This CLI give the possibility to do a queries in Star Wars API and returns a JSON in a terminal. Install $ pip install swcli Qu

Pery Lemke 5 Nov 05, 2021
Ros command - Unifying the ROS command line tools

Unifying the ROS command line tools One impairment to ROS 2 adoption is that all

37 Dec 15, 2022
A handy command-line utility for generating and sending iCalendar events

A handy command-line utility for generating and sending iCalendar events This simple command-line utility is designed to generate an iCalendar event,

Baochun Li 17 Nov 21, 2022
A CLI for advanced management of your notes with simple commands

PyNoteManager This is a CLI for advanced management of your notes with simple co

3 Dec 30, 2021
A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli.

ABOUT A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli. Installation pip install -r requirements.txt It use

Janardon Hazarika 17 Dec 11, 2022
A **CLI** folder organizer written in Python.

Fsorter Introduction A CLI folder organizer written in Python. Dependencies Before installing, install the following dependencies: Ubuntu/Debain Based

1 Nov 17, 2021
Multifunctional library for creating progress bars.

πŸ‘‹ Content Installation Using github Using pypi Quickstart Flags Useful links Documentation Pypi Changelog TODO Contributing FAQ Bar structure βš™οΈ Inst

DenyS 27 Jan 01, 2023
A simple automation script that logs into your kra account and files your taxes with one command

EASY_TAX A simple automation script that logs into your kra account and files your taxes with one command Currently works for Chrome users. Will creat

leon koech 13 Sep 23, 2021
Magma is a NeoVim plugin for running code interactively with Jupyter.

Magma Magma is a NeoVim plugin for running code interactively with Jupyter. Requirements NeoVim 0.5+ Python 3.8+ Required Python packages: pynvim (for

Daniel Csillag 372 Dec 26, 2022
Command-line interface to PyPI Stats API to get download stats for Python packages

pypistats Python 3.6+ interface to PyPI Stats API to get aggregate download statistics on Python packages on the Python Package Index without having t

Hugo van Kemenade 140 Jan 03, 2023