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)
A minimal todo list for your terminal.

todo A minimal todo list for your terminal. Installation Run the following command. pip install git+https://github.com/piero-vic/todo.git Usage todo

Piero Lescano 7 Aug 08, 2022
Color preview command-line tool written in python

Color preview command-line tool written in python

Arnau 1 Dec 27, 2021
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 simple CLI tool for tracking Pikud Ha'oref alarms.

Pikud Ha'oref Alarm Tracking A simple CLI tool for tracking Pikud Ha'oref alarms. Polls the unofficial API endpoint every second for incoming alarms.

Yuval Adam 24 Oct 10, 2022
Bad Apple printed out on the console with Python!

Bad Apple printed out on the console with Python!

CalvinLoke 186 Dec 01, 2022
Random scripts and other bits for interacting with the SpaceX Starlink user terminal hardware

starlink-grpc-tools This repository has a handful of tools for interacting with the gRPC service implemented on the Starlink user terminal (AKA "the d

270 Dec 29, 2022
xonsh is a Python-powered, cross-platform, Unix-gazing shell

xonsh is a Python-powered, cross-platform, Unix-gazing shell language and command prompt.

xonsh 6.7k Dec 31, 2022
CryptoCo-py is a Python CLI application that uses CoinGecko API to allow the user to query cryptocurrency information by typing simple commands.

CryptoCo-py is a Python CLI application that uses CoinGecko API to allow the user to query cryptocurrency information by typing simple com

1 Jan 10, 2022
Command Line (CLI) Application to automate creation of tasks in Redmine, issues on Github and the sync process of them.

Task Manager Automation Tool (TMAT) CLI Command Line (CLI) Application to automate creation of tasks in Redmine, issues on Github and the sync process

Tiamat 5 Apr 12, 2022
A simple CLI tool for converting logs from Poker Now games to other formats

πŸ‚‘ Poker Now Log Converter πŸ‚‘ A command line utility for converting logs from Poker Now games to other formats. Introduction Poker Now is a free onlin

6 Dec 23, 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
Get Air Quality Index for your city/country 😷

Air Quality Index CLI Get Air Quality index for your City. Installation $ pip install air-quality-cli Contents Air Quality Index CLI Installation Cont

Yankee 40 Oct 21, 2022
Cli tool to browse and play anime

browse and watch anime (scrape from gogoanime) (wip) basically ani-cli but in python cuz python good demo dependencies mpv installation from pypi pip

sheep padowo 2 Apr 20, 2022
AutoSub is a CLI application to generate subtitle files (.srt, .vtt, and .txt transcript) for any video file using Mozilla DeepSpeech.

AutoSub About Motivation Installation Docker How-to example How it works TO-DO Contributing References About AutoSub is a CLI application to generate

Abhiroop Talasila 414 Jan 06, 2023
🐍The nx-python plugin allows users to create a basic python application using nx commands.

🐍 NxPy: Nx Python plugin This project was generated using Nx. The nx-python plugin allows users to create a basic python application using nx command

StandUP Communications 74 Aug 31, 2022
Powerful yet easy command line calculator.

Powerful yet easy command line calculator.

Cruisen 1 Jul 22, 2022
A command line tool that creates a super timeline from SentinelOne's Deep Visibility data

S1SuperTimeline A command line tool that creates a super timeline from SentinelOne's Deep Visibility data What does it do? The script accepts a S1QL q

Juan Ortega 2 Feb 08, 2022
A dashboard for your Terminal written in the Python 3 language,

termDash is a handy little program, written in the Python 3 language, and is a small little dashboard for your terminal, designed to be a utility to help people, as well as helping new users get used

Rebecca White 2 Dec 03, 2021
TermPair lets developers securely share and control terminals in real timeπŸ”’

View and control terminals from your browser with end-to-end encryption πŸ”’

Chad Smith 1.5k Jan 05, 2023
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