# urWIDgets
A collection of widgets for [urwid](https://urwid.org)
## Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contribution](#contribution)
- [Sponsor This Project](#sponsor-this-project)
## Installation
### Requirements
- [Python](https://www.python.org/) >= 3.7
- [urwid](https://github.com/urwid/urwid/wiki/Installation-instructions) (will be installed automatically)
### Steps
The latest **stable** version can be installed from [PyPI](https://pypi.org/project/urwidgets) with:
```shell
pip install urwidgets
```
The **development** version can be installed with:
```shell
pip install git+https://github.com/AnonymouX47/urwidgets.git
```
## Usage
<p align="center"><b>
🚧 There might be incompatible changes between minor versions of
<a href='https://semver.org/spec/v2.0.0.html#spec-item-4'>version zero</a>!
</b></p>
**If you want to use this library in a project while it's still on version zero, ensure you pin the dependency to a specific minor version e.g `>=0.1,<0.2`.**
See the [docs](https://urwidgets.readthedocs.io) for the API Reference (with usage examples).
## Contribution
Please read through the [guidelines](https://github.com/AnonymouX47/urwidgets/blob/main/CONTRIBUTING.md).
## Sponsor This Project
<a href="https://www.buymeacoffee.com/anonymoux47" target="_blank">
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" >
</a>
Any amount will go a long way in aiding the progress and development of this project.
Thank you! 💓
Raw data
{
"_id": null,
"home_page": "https://github.com/AnonymouX47/urwidgets",
"name": "urwidgets",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "terminal, console, xterm, library, tui, urwid, curses",
"author": "AnonymouX47",
"author_email": "anonymoux47@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/91/cc/4e2469c469e72c68a45b1750854a496e15f21718ae8e3bc22cf7d89f7459/urwidgets-0.2.1.tar.gz",
"platform": null,
"description": "# urWIDgets\n\nA collection of widgets for [urwid](https://urwid.org)\n\n## Contents\n- [Installation](#installation)\n- [Usage](#usage)\n- [Contribution](#contribution)\n- [Sponsor This Project](#sponsor-this-project)\n\n\n## Installation\n\n### Requirements\n- [Python](https://www.python.org/) >= 3.7\n- [urwid](https://github.com/urwid/urwid/wiki/Installation-instructions) (will be installed automatically)\n\n### Steps\nThe latest **stable** version can be installed from [PyPI](https://pypi.org/project/urwidgets) with:\n\n```shell\npip install urwidgets\n```\n\nThe **development** version can be installed with:\n\n```shell\npip install git+https://github.com/AnonymouX47/urwidgets.git\n```\n\n\n## Usage\n\n<p align=\"center\"><b>\n \ud83d\udea7 There might be incompatible changes between minor versions of\n <a href='https://semver.org/spec/v2.0.0.html#spec-item-4'>version zero</a>!\n</b></p>\n\n**If you want to use this library in a project while it's still on version zero, ensure you pin the dependency to a specific minor version e.g `>=0.1,<0.2`.**\n\nSee the [docs](https://urwidgets.readthedocs.io) for the API Reference (with usage examples).\n\n## Contribution\n\nPlease read through the [guidelines](https://github.com/AnonymouX47/urwidgets/blob/main/CONTRIBUTING.md).\n\n## Sponsor This Project\n\n<a href=\"https://www.buymeacoffee.com/anonymoux47\" target=\"_blank\">\n <img src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 60px !important;width: 217px !important;\" >\n</a>\n\nAny amount will go a long way in aiding the progress and development of this project.\nThank you! \ud83d\udc93\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A collection of widgets for urwid (https://urwid.org)",
"version": "0.2.1",
"project_urls": {
"Changelog": "https://github.com/AnonymouX47/urwidgets/blob/main/CHANGELOG.md",
"Documentation": "https://urwidgets.readthedocs.io/",
"Homepage": "https://github.com/AnonymouX47/urwidgets",
"Source": "https://github.com/AnonymouX47/urwidgets",
"Tracker": "https://github.com/AnonymouX47/urwidgets/issues"
},
"split_keywords": [
"terminal",
" console",
" xterm",
" library",
" tui",
" urwid",
" curses"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3abc33fec53bba284b77eddca302fd7ca23c1679395d7930e05810a4fcd0b064",
"md5": "e79918ca6de16e3b2f04e169492fb7de",
"sha256": "aeb48b9c8cfd77a4f1c1518d4ad24d7d6b15e2d8057af357deaf649b9ce37329"
},
"downloads": -1,
"filename": "urwidgets-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e79918ca6de16e3b2f04e169492fb7de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 14355,
"upload_time": "2024-08-31T11:18:23",
"upload_time_iso_8601": "2024-08-31T11:18:23.878068Z",
"url": "https://files.pythonhosted.org/packages/3a/bc/33fec53bba284b77eddca302fd7ca23c1679395d7930e05810a4fcd0b064/urwidgets-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91cc4e2469c469e72c68a45b1750854a496e15f21718ae8e3bc22cf7d89f7459",
"md5": "bffb5c8057874dc769db4cabd28961b1",
"sha256": "f9f2bcd2949da1105c287806dab773aa7bdf5852226cdb128aaf3004136f3eef"
},
"downloads": -1,
"filename": "urwidgets-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "bffb5c8057874dc769db4cabd28961b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14544,
"upload_time": "2024-08-31T11:18:26",
"upload_time_iso_8601": "2024-08-31T11:18:26.095036Z",
"url": "https://files.pythonhosted.org/packages/91/cc/4e2469c469e72c68a45b1750854a496e15f21718ae8e3bc22cf7d89f7459/urwidgets-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-31 11:18:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AnonymouX47",
"github_project": "urwidgets",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "urwidgets"
}
JSON
