# `BulletPrompt` : Beautiful Python Prompts Made Simple
<p align=center>
<br><br><br>
<img src="./assets/icon.png" width="400">
<br><br><br>
<a target="_blank"><img src="https://img.shields.io/badge/platform-linux-lightgrey.svg"></a>
<a target="_blank" href="https://www.python.org/downloads/" title="Python version"><img src="https://img.shields.io/badge/python-%3E=_3.6-green.svg"></a>
<a target="_blank" href="https://opensource.org/licenses/MIT" title="License: MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
<a target="_blank" href="http://makeapullrequest.com" title="PRs Welcome"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"></a>
</p>
## Maintained Version of Bullet
This project is a fork of the original `bullet` project. The original project is no longer maintained. This fork is maintained by the community and is actively developed. The original project can be found [here](https://github.com/bchao1/bullet).
### This repo is actively migrating documentation and configuration. We will be updating this as time goes on.
***
> 🎨 Customize prompts in your Python CLI tool. Extensive support for formatting, colors, background colors, styling, and etc. Also supports emojis!
***
<p align="center">
<img src="./assets/gifs/demo.gif" width=800>
</p>
> See the sample code for the above demo in `./examples/prompt.py`.
## Bullet-lists and checkboxes
> 🎨 Robust support for user-defined styles.
<table>
<tr>
<th>./examples/classic.py</th>
<th>./examples/colorful.py</th>
<th>./examples/star.py</th>
</tr>
<tr>
<td><img src="./assets/gifs/classic.gif" width="200"/></td>
<td><img src="./assets/gifs/colorful.gif" width="200"/></td>
<td><img src="./assets/gifs/star.gif" width="200"/></td>
</tr>
<tr>
<th>Vanilla checkbox</th>
<th>Checkbox + styles.Exam</th>
<th>Bullet + styles.Greece</th>
</tr>
<tr>
<td><img src="./assets/gifs/checkbox.gif" width="200"/></td>
<td><img src="./assets/gifs/exam.gif" width="200"/></td>
<td><img src="./assets/gifs/greece.gif" width="200"/></td>
</tr>
<tr>
<th>Bullet + styles.Ocean</th>
<th>Bullet + styles.Lime</th>
<th>Bullet + styles.Christmas</th>
</tr>
<tr>
<td><img src="./assets/gifs/ocean.gif" width="200"/></td>
<td><img src="./assets/gifs/lime.gif" width="200"/></td>
<td><img src="./assets/gifs/christmas.gif" width="200"/></td>
</tr>
</table>
## ScrollBar
<p align="center">
<img src="./assets/gifs/scrollbar.gif" width=400>
</p>
> See the sample code for the above demo in `./examples/scrollbar.py`.
## Other input prompts
> ⛔ Passwords
<img src="./assets/gifs/password.gif" width="600"/>
> 👍 Yes/No Questions
<img src="./assets/gifs/yesno.gif" width="600"/>
> 🔢 Numbers
<img src="./assets/gifs/numbers.gif" width="600"/>
## Setting up `BulletPrompt`
>
> From PyPI
```shell
$ pip install BulletPrompt
```
> Build from Source
```shell
$ git clone https://github.com/danner26/BulletPrompt.git
$ cd BulletPrompt
$ pip install .
```
## Documentation
📖 See <a href="./DOCUMENTATION.md"> Documentation</a>.
> Currently supported prompts: `Bullet`, `Check`, `Input`, `Numbers`, `Password`, `YesNo`, `VerticalPrompt`, `SlidePrompt`, `Scrollbar`.
## Contributing
🎉 Directly send PRs! Make sure development is done and tested in `Python >= 3.6`.
## Todo
- Windows Support
- Search bar with autocomplete
Raw data
{
"_id": null,
"home_page": "https://github.com/danner26/BulletPrompt",
"name": "BulletPrompt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "cli list prompt customize colors",
"author": "danner26",
"author_email": "daniel.anner@danstechsupport.com",
"download_url": "https://files.pythonhosted.org/packages/ba/65/ba986b70ec59562578430c248e40c04bb671a009bcd5014099a10f4722b9/bulletprompt-2.2.1.tar.gz",
"platform": null,
"description": "# `BulletPrompt` : Beautiful Python Prompts Made Simple\n<p align=center>\n<br><br><br>\n<img src=\"./assets/icon.png\" width=\"400\">\n<br><br><br>\n<a target=\"_blank\"><img src=\"https://img.shields.io/badge/platform-linux-lightgrey.svg\"></a>\n<a target=\"_blank\" href=\"https://www.python.org/downloads/\" title=\"Python version\"><img src=\"https://img.shields.io/badge/python-%3E=_3.6-green.svg\"></a>\n<a target=\"_blank\" href=\"https://opensource.org/licenses/MIT\" title=\"License: MIT\"><img src=\"https://img.shields.io/badge/License-MIT-blue.svg\"></a>\n<a target=\"_blank\" href=\"http://makeapullrequest.com\" title=\"PRs Welcome\"><img src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\"></a>\n</p>\n\n## Maintained Version of Bullet\n\nThis project is a fork of the original `bullet` project. The original project is no longer maintained. This fork is maintained by the community and is actively developed. The original project can be found [here](https://github.com/bchao1/bullet).\n\n### This repo is actively migrating documentation and configuration. We will be updating this as time goes on.\n\n***\n> \ud83c\udfa8 Customize prompts in your Python CLI tool. Extensive support for formatting, colors, background colors, styling, and etc. Also supports emojis!\n***\n\n<p align=\"center\">\n <img src=\"./assets/gifs/demo.gif\" width=800>\n</p>\n\n> See the sample code for the above demo in `./examples/prompt.py`.\n\n## Bullet-lists and checkboxes\n> \ud83c\udfa8 Robust support for user-defined styles.\n<table>\n <tr>\n <th>./examples/classic.py</th>\n <th>./examples/colorful.py</th>\n <th>./examples/star.py</th>\n </tr>\n <tr>\n <td><img src=\"./assets/gifs/classic.gif\" width=\"200\"/></td>\n <td><img src=\"./assets/gifs/colorful.gif\" width=\"200\"/></td>\n <td><img src=\"./assets/gifs/star.gif\" width=\"200\"/></td>\n </tr>\n <tr>\n <th>Vanilla checkbox</th>\n <th>Checkbox + styles.Exam</th>\n <th>Bullet + styles.Greece</th>\n </tr>\n <tr>\n <td><img src=\"./assets/gifs/checkbox.gif\" width=\"200\"/></td>\n <td><img src=\"./assets/gifs/exam.gif\" width=\"200\"/></td>\n <td><img src=\"./assets/gifs/greece.gif\" width=\"200\"/></td>\n </tr>\n <tr>\n <th>Bullet + styles.Ocean</th>\n <th>Bullet + styles.Lime</th>\n <th>Bullet + styles.Christmas</th>\n </tr>\n <tr>\n <td><img src=\"./assets/gifs/ocean.gif\" width=\"200\"/></td>\n <td><img src=\"./assets/gifs/lime.gif\" width=\"200\"/></td>\n <td><img src=\"./assets/gifs/christmas.gif\" width=\"200\"/></td>\n </tr>\n</table>\n\n## ScrollBar\n\n<p align=\"center\">\n <img src=\"./assets/gifs/scrollbar.gif\" width=400>\n</p>\n\n> See the sample code for the above demo in `./examples/scrollbar.py`.\n\n## Other input prompts\n> \u26d4 Passwords\n<img src=\"./assets/gifs/password.gif\" width=\"600\"/>\n\n> \ud83d\udc4d Yes/No Questions\n<img src=\"./assets/gifs/yesno.gif\" width=\"600\"/>\n\n> \ud83d\udd22 Numbers\n<img src=\"./assets/gifs/numbers.gif\" width=\"600\"/>\n\n## Setting up `BulletPrompt`\n>\n> From PyPI\n```shell\n$ pip install BulletPrompt\n```\n> Build from Source\n```shell\n$ git clone https://github.com/danner26/BulletPrompt.git\n$ cd BulletPrompt\n$ pip install .\n```\n## Documentation\n\ud83d\udcd6 See <a href=\"./DOCUMENTATION.md\"> Documentation</a>.\n\n> Currently supported prompts: `Bullet`, `Check`, `Input`, `Numbers`, `Password`, `YesNo`, `VerticalPrompt`, `SlidePrompt`, `Scrollbar`.\n\n## Contributing\n\ud83c\udf89 Directly send PRs! Make sure development is done and tested in `Python >= 3.6`.\n\n## Todo\n- Windows Support\n- Search bar with autocomplete\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Beautiful Python prompts made simple. Maintained version of bchao1/bullet.",
"version": "2.2.1",
"project_urls": {
"Homepage": "https://github.com/danner26/BulletPrompt",
"Source Code": "https://github.com/danner26/BulletPrompt"
},
"split_keywords": [
"cli",
"list",
"prompt",
"customize",
"colors"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8c9fd5463ef88d2c76caba7e90160276d504015adefff9907e95c2d2fa0e876f",
"md5": "dd3258cfd1b4a5a38c53846975a8a9d1",
"sha256": "046ff71e0664e6a1090bd19abaa13400ed79f0473be511cf76ccd24dc3533992"
},
"downloads": -1,
"filename": "BulletPrompt-2.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dd3258cfd1b4a5a38c53846975a8a9d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 11796,
"upload_time": "2025-01-21T19:20:39",
"upload_time_iso_8601": "2025-01-21T19:20:39.575392Z",
"url": "https://files.pythonhosted.org/packages/8c/9f/d5463ef88d2c76caba7e90160276d504015adefff9907e95c2d2fa0e876f/BulletPrompt-2.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba65ba986b70ec59562578430c248e40c04bb671a009bcd5014099a10f4722b9",
"md5": "ae07415343223b114c8be5e79ace5db2",
"sha256": "70cd16181bad012dfa791c3a683ba12a073613613307c5a4bbc50f269348be78"
},
"downloads": -1,
"filename": "bulletprompt-2.2.1.tar.gz",
"has_sig": false,
"md5_digest": "ae07415343223b114c8be5e79ace5db2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 10379,
"upload_time": "2025-01-21T19:20:40",
"upload_time_iso_8601": "2025-01-21T19:20:40.771246Z",
"url": "https://files.pythonhosted.org/packages/ba/65/ba986b70ec59562578430c248e40c04bb671a009bcd5014099a10f4722b9/bulletprompt-2.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-21 19:20:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "danner26",
"github_project": "BulletPrompt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bulletprompt"
}
JSON
