{"id":37085190,"url":"https://github.com/devcoons/consolio","last_synced_at":"2026-01-14T10:28:19.412Z","repository":{"id":259504205,"uuid":"878161801","full_name":"devcoons/consolio","owner":"devcoons","description":"A simple terminal I/O utility with spinner animation","archived":false,"fork":false,"pushed_at":"2025-10-08T22:35:33.000Z","size":43,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-08T23:20:36.370Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devcoons.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-24T21:45:16.000Z","updated_at":"2025-10-08T22:35:36.000Z","dependencies_parsed_at":"2024-10-26T03:15:32.070Z","dependency_job_id":"6bc33a6c-b98e-4a24-ab5e-5fd181c53d3c","html_url":"https://github.com/devcoons/consolio","commit_stats":null,"previous_names":["devcoons/consolio"],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/devcoons/consolio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devcoons%2Fconsolio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devcoons%2Fconsolio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devcoons%2Fconsolio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devcoons%2Fconsolio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devcoons","download_url":"https://codeload.github.com/devcoons/consolio/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devcoons%2Fconsolio/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28417230,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T10:25:19.714Z","status":"ssl_error","status_checked_at":"2026-01-14T10:22:49.371Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-14T10:28:18.734Z","updated_at":"2026-01-14T10:28:19.404Z","avatar_url":"https://github.com/devcoons.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Consolio\n\n[![PyPI - Version](https://img.shields.io/pypi/v/consolio?style=for-the-badge)](https://pypi.org/project/consolio)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/consolio?style=for-the-badge)\n![GitHub License](https://img.shields.io/github/license/devcoons/consolio?style=for-the-badge)\n![PyPI - Wheel](https://img.shields.io/pypi/wheel/consolio?style=for-the-badge\u0026color=%23F0F)\n\n`Consolio` is a lightweight, dependency-free Python library that provides an elegant way to display progress updates, warnings, errors, and other status messages in the console with color-coded indicators, spinners, and progress bars.\n\nPerfect for CLI tools that need clean, structured feedback without complex dependencies.\n\n---\n\n## Installation\n\nConsolio has **no external dependencies** and works out of the box.\n\n```bash\npip install consolio\n```\n\nIf you’re using it directly from source (e.g., cloned repository), add the `src/` folder to your `PYTHONPATH` or `sys.path`:\n\n```python\nimport sys, os\nsys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), 'src')))\nfrom consolio import Consolio\n```\n\n---\n\n## Features\n\n- ✅ Color-coded messages for info, warning, error, success, and more.  \n- 🔁 Built-in progress **spinners** (`dots`, `braille`, `default`).  \n- 📈 Context-managed **progress bars**.  \n- 🧩 Thread-safe and clean terminal rendering (no output corruption).  \n- ⚙️ Works gracefully in both **TTY** and **non-TTY** (plain/CI) modes.  \n- 🔄 Indentation helpers (`increase_indent`, `decrease_indent`, etc.) for hierarchical output.  \n\n---\n\n## Basic Usage\n\n```python\nfrom consolio import Consolio\n\nconsole = Consolio(spinner_type='dots')\n\nconsole.print(\"inf\", \"Starting process\")\nconsole.print(\"wip\", \"Loading configuration...\")\nconsole.print(\"wrn\", \"Warning: Low memory detected\")\nconsole.print(\"err\", \"Error: Invalid input detected\")\nconsole.print(\"cmp\", \"All done!\")\n```\n\n---\n\n## Indentation Control\n\nYou can now manage indentation dynamically without passing it every time.\n\n```python\nconsole.increase_indent()\nconsole.print(\"wip\", \"Setting up environment...\")\n\nconsole.increase_indent()\nconsole.print(\"inf\", \"Fetching dependencies...\")\n\nconsole.decrease_indent()\nconsole.print(\"cmp\", \"Setup complete.\")\n```\n\nExplicit indentation still works:\n\n```python\nconsole.print(2, \"inf\", \"Manual indentation works too.\")\n```\n\n---\n\n## Spinners\n\nUse the spinner as a **context manager**:\n\n```python\nimport time\n\nwith console.spinner(\"Working hard...\", inline=True):\n    time.sleep(2)\n\nconsole.print(\"cmp\", \"Task complete!\")\n```\n\nOr manually start and stop it:\n\n```python\nconsole.start_animate()\ntime.sleep(3)\nconsole.stop_animate()\n```\n\n---\n\n## Progress Bars\n\n```python\nimport time\n\nwith console.progress(initial_percentage=0) as update:\n    for i in range(0, 101, 20):\n        time.sleep(0.3)\n        update(i)\n\nconsole.print(\"cmp\", \"Progress complete!\")\n```\n\n---\n\n## Input Handling\n\n```python\nuser = console.input(\"qst\", \"Enter your name:\")\nconsole.print(\"cmp\", f\"Hello, {user}!\")\n```\n\n---\n\n##  Customization\n\n| Option | Description | Example |\n|---------|-------------|----------|\n| `spinner_type` | Type of spinner (`dots`, `braille`, `default`) | `Consolio(spinner_type='braille')` |\n| `no_colors` | Disable ANSI colors | `Consolio(no_colors=True)` |\n| `no_animation` | Disable spinners/progress bars | `Consolio(no_animation=True)` |\n| `replace=True` | Overwrite previous message line | `console.print(\"inf\", \"Updating...\", replace=True)` |\n| `plain()` | Force plain output (no color/animation) | `console.plain()` |\n| `rich()` | Re-enable color/animation if supported | `console.rich()` |\n\n\n## Example Structure\n\nExample scripts are located in the [`examples/`](examples/) folder:\n- `example_basic_usage.py` — Interactive demo with spinner and progress bar.  \n- `example_plain_mode.py` — CI-friendly non-interactive demo.\n\nRun them directly:\n\n```bash\npython examples/example_basic_usage.py\n```\n\n\n## License\n\nThis project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details.\n\n---\n\nMade with ❤️ by [devcoons](https://github.com/devcoons)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevcoons%2Fconsolio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevcoons%2Fconsolio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevcoons%2Fconsolio/lists"}