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)
This a simple tool to query the awesome ippsec.rocks website from your terminal

ippsec-cli This a simple tool to query the awesome ippsec.rocks website from your terminal Installation and usage cd /opt git clone https://github.com

stark0de 5 Nov 26, 2022
Python Processing Tool for Vasp Ipnut/Output

PivotPy A Python Processing Tool for Vasp Input/Output. A CLI is available in Powershell, see Vasp2Visual. stylea{text-decoration: none !important;c

Abdul Saboor 5 Aug 16, 2022
Quickly open any path on your terminal window in your $EDITOR of choice!

Tmux fpp Plugin wrapper around Facebook PathPicker. Quickly open any path on your terminal window in your $EDITOR of choice! Demo Dependencies fpp - F

257 Dec 28, 2022
Format click help output nicely with rich.

rich-click Format click help output nicely with Rich. Click is a "Python package for creating beautiful command line interfaces". Rich is a "Python li

Phil Ewels 333 Jan 02, 2023
A command-line tool to flash python code to Codey Rocky without having to use the online mblock5 IDE.

What? A command-line tool to flash python code to Codey Rocky without having to use the online mblock5 IDE. Description This is a very low-effort proj

1 Dec 29, 2021
An question and answer shell environment based on xonsh using ansible for setup

An question and answer shell environment based on xonsh using ansible for setup

Steven Hollingsworth 2 Jan 11, 2022
moviepy-cli: Command line interface for MoviePy.

Moviepy-cli is designed to apply several video editing in a single command with Moviepy as an alternative to Video-cli.

Kentaro Wada 23 Jun 29, 2022
'rl_UK' is an open-source command-line tool in Python for calculating the shortest path between BUS stop sequences in the UK

'rl_UK' is an open-source command-line tool in Python for calculating the shortest path between BUS stop sequences in the UK. As input files, it uses an ATCO-CIF file and 'OS Open Roads' dataset from

Nesh P. 0 Feb 16, 2022
Baseline is a cross-platform library and command-line utility that creates file-oriented baselines of your systems.

Baselining, on steroids! Baseline is a cross-platform library and command-line utility that creates file-oriented baselines of your systems. The proje

Nelson 4 Dec 09, 2022
This is the public repo for the VS Code Extension AT&T i386/IA32 UIUC-ECE391 Syntax Highlighting

AT&T i386 IA32 UIUC ECE391 GCC Highlighter & Snippet & Linter This is the VS Code Extension for UIUC ECE 391, MIT 6.828, and all other AT&T-based i386

Jackgetup 1 Feb 05, 2022
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
Shazam is a Command Line Application that checks the integrity of the file by comparing it with a given hash.

SHAZAM - Check the file's integrity Shazam is a Command Line Application that checks the integrity of the file by comparing it with a given hash. Crea

Anaxรญmeno Brito 1 Aug 21, 2022
๐Ÿ’ป Physics2Calculator - A simple and powerful calculator for Physics 2

๐Ÿ’ป Physics2Calculator A simple and powerful calculator for Physics 2 ๐Ÿ”Œ Predefined constants pi = 3.14159... k = 8988000000 (coulomb constant) e0 = 8.

Dylan Tintenfich 4 Dec 01, 2021
Neovim integration for Google Keep, built using gkeepapi

Gkeep.nvim Neovim integration for Google Keep, built using gkeepapi Requirements Neovim 0.5 Python 3.6+ A patched font (optional. Used for icons) Tabl

Steven Arcangeli 143 Jan 02, 2023
A simple cli tool to commit Conventional Commits

convmoji A simple cli tool to commit Conventional Commits. Requirements Install pip install convmoji convmoji --help Examples A conventianal commit co

3 Jul 04, 2022
Wordle for CLUE - WORDLE clone for Adafruit Clue

Wordle_for_CLUE This project is a clone of the very popular word solving puzzle

Michael Lacock 4 Feb 15, 2022
A simple script that outputs the current date on the user interface/terminal.

Py-Date A simple script that outputs the current date on the user interface/terminal. How to Run Open your terminal and cd into the folder containi

Arinzechukwu Okoye 1 Jan 13, 2022
Unpacks things.

$ unp_ unp is a command line tool that can unpack archives easily. It mainly acts as a wrapper around other shell tools that you can find on v

Armin Ronacher 405 Jan 03, 2023
Pynavt is a cli tool to create clean architecture app for you including Fastapi, bcrypt and jwt.

Pynavt _____ _ | __ \ | | | |__) | _ _ __ __ ___ _| |_ | ___/ | | | '_ \ / _` \ \ / /

Alejandro Castillo 1 Dec 13, 2021
dsub is a command-line tool that makes it easy to submit and run batch scripts in the cloud.

Open-source command-line tool to run batch computing tasks and workflows on backend services such as Google Cloud.

Data Biosphere 233 Jan 01, 2023