Skip to main content

Making development of console-based apps a little more convenient

Project description

cozyconsole

Caveat

This package exists to support my other projects. Those may require breaking changes in here. Consequently, cozyconsole may never become "stable", never reach v1.0.0. Considering how little is in here at the moment, it is probably not worth your time.

If you are still reading

cozyconsole currently contains:

cozyconsole.consolex.ConsoleX is a trivial wrapper around rich.console.Console. It exists to avoid code duplication anti-patterns in my other projects.

cozyconsole.activity.Activity is a context manager for operations that run for a few seconds each. It displays a message while a piece of code is executing. When the execution is complete, its status is shown.

from time import sleep
from cozyconsole.activity import Activity
with Activity("Updating dependencies") as act:
   sleep(3)   # simulating the actual code
   act.success = True

This displays

Collecting dependencies...

until the code finishes (here: 3 seconds), then updates that to show

Collecting dependencies - done

Activity can handle warnings, errors, and expections in various ways. Run

% python3 -m cozyconsole.demo

to see more.

Ideas for v0.5.0 and beyond

  • Evaluate if Activity should use rich.status.
  • Activity and ConsoleX error and warning colors should be configurable via a TOML config file.
  • A Rich-based horizontal barchart "widget".

Credits

Rich

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

cozyconsole-0.4.1.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

cozyconsole-0.4.1-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file cozyconsole-0.4.1.tar.gz.

File metadata

  • Download URL: cozyconsole-0.4.1.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for cozyconsole-0.4.1.tar.gz
Algorithm Hash digest
SHA256 7db854256188cd3de1d9b678447f24a9efb3edef6eba3d08613f534367270a77
MD5 95e347dce368ff7bb5fdf808739838d5
BLAKE2b-256 2f3196d6ea912fdb5ec2cfb11c08514ed45466fcfb3d907f1e8da2ffd37886d9

See more details on using hashes here.

File details

Details for the file cozyconsole-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: cozyconsole-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for cozyconsole-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 73bf8d575df651062a8b407c3e0b28f91b350932a0f00f3292541825582d38e4
MD5 d1149f68bb37f851bf91624a5f252a09
BLAKE2b-256 2bea604695720ef3da6622afec4897664b876a47fdfb100f4c2301719782ffdd

See more details on using hashes here.

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