| Name | rye-tui JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | None |
| Summary | Rye meets Textual. Manage your python projects with a Tui |
| upload_time | 2024-07-27 17:16:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
python
rye
textual
tui
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://rye-up.com)
[](https://pypi.org/project/rye-tui/)
[](https://pypi.python.org/pypi/rye-tui)
[](https://github.com/astral-sh/rye-tui/blob/main/LICENSE)
[](https://pepy.tech/project/rye-tui)
# rye-tui
> Rye meets Textual. Manage your python projects with a Tui
rye-tui is a CLI tool to manage your [rye] projects. It offers a UI to interact with your projects.
## Currently still under development
For a list of missing features check the [Open Points](#open-points) below
## Installation
You can already install a first release with one of the three options:
```bash
pip install rye-tui
```
```bash
pipx install rye-tui
```
```bash
rye install rye-tui
```
I recommend using [pipx] or [rye] to install CLI Tools into an isolated environment.
## Usage
Once installed, you can open the tui with
```bash
trye
```
On first execution a configuration file is created. Afterwards you can run `trye` again to get into the tui view.
The configuration file contains a list of the paths of your rye-managed pojects.
Also a project home directory is defined (default: `HOMEPATH`), which helps initializing new projects under a certain location.
Rye-Tui is following the [XDG] basedir-spec. Therefore the configuration file is located under your OS specific `config_user_dir`.
## Features
Rye-Tui is divided into 3 Tabs:
1. Projects
2. General
3. Config
### Projects Tab
The Projects Tab holds all your rye projects and gives you an overview to each project based on the `pyproject.toml` and installed packages.
`Edit`- Button function to open pyproject.toml is still missing currently.
`rye add` and `rye add --dev` is already supported, flags are still missing currently.
### General Tab
The General Tab has an input field to define your project-home path, which acts as an default location, to easily create a new project there.
Furthermore you get an overview over your globally installed tools including version and available scripts.
The final section lists all installed toolchain.
### Config Tab
The Config Tab can be used to change rye's underlying config.
## Feedback and Issues
Feel free to reach out and share your feedback, or open an Issue, if something doesnt work as expected.
Also check the [Changelog](https://github.com/Zaloog/rye-tui/blob/main/CHANGELOG.md) for new updates.
## Open Points:
- [ ] Support Flags for Rye Init and Rye add
- [ ] Support publishing
- [ ] Enable Rye Tool Management, like rye add
- [ ] Folder Scanner for rye projects
[XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
[platformdirs]: https://platformdirs.readthedocs.io/en/latest/
[textual]: https://textual.textualize.io
[pipx]: https://github.com/pypa/pipx
[rye]: https://rye-up.com
[PyPi]: https://pypi.org/project/rye-tui/
Raw data
{
"_id": null,
"home_page": null,
"name": "rye-tui",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "python, rye, textual, tui",
"author": null,
"author_email": "Zaloog <gramslars@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/46/d8/1f0d2a6874a90b1fde84129263b24208a502e4bf212bdefcb5549da7369b/rye_tui-0.5.1.tar.gz",
"platform": null,
"description": "\n[](https://rye-up.com)\n[](https://pypi.org/project/rye-tui/)\n[](https://pypi.python.org/pypi/rye-tui)\n[](https://github.com/astral-sh/rye-tui/blob/main/LICENSE)\n[](https://pepy.tech/project/rye-tui)\n\n# rye-tui\n\n> Rye meets Textual. Manage your python projects with a Tui\n\nrye-tui is a CLI tool to manage your [rye] projects. It offers a UI to interact with your projects.\n\n\n\n## Currently still under development\nFor a list of missing features check the [Open Points](#open-points) below\n\n## Installation\n\nYou can already install a first release with one of the three options:\n\n```bash\npip install rye-tui\n```\n\n```bash\npipx install rye-tui\n```\n\n```bash\nrye install rye-tui\n```\nI recommend using [pipx] or [rye] to install CLI Tools into an isolated environment.\n\n## Usage\n\nOnce installed, you can open the tui with\n```bash\ntrye\n```\n\nOn first execution a configuration file is created. Afterwards you can run `trye` again to get into the tui view.\n\nThe configuration file contains a list of the paths of your rye-managed pojects.\nAlso a project home directory is defined (default: `HOMEPATH`), which helps initializing new projects under a certain location.\n\nRye-Tui is following the [XDG] basedir-spec. Therefore the configuration file is located under your OS specific `config_user_dir`.\n\n\n## Features\n\nRye-Tui is divided into 3 Tabs:\n1. Projects\n2. General\n3. Config\n\n### Projects Tab\nThe Projects Tab holds all your rye projects and gives you an overview to each project based on the `pyproject.toml` and installed packages.\n`Edit`- Button function to open pyproject.toml is still missing currently. \n\n\n`rye add` and `rye add --dev` is already supported, flags are still missing currently.\n\n\n### General Tab\nThe General Tab has an input field to define your project-home path, which acts as an default location, to easily create a new project there.\nFurthermore you get an overview over your globally installed tools including version and available scripts.\nThe final section lists all installed toolchain.\n\n\n### Config Tab\nThe Config Tab can be used to change rye's underlying config.\n\n\n## Feedback and Issues\nFeel free to reach out and share your feedback, or open an Issue, if something doesnt work as expected.\nAlso check the [Changelog](https://github.com/Zaloog/rye-tui/blob/main/CHANGELOG.md) for new updates.\n\n## Open Points:\n- [ ] Support Flags for Rye Init and Rye add\n- [ ] Support publishing\n- [ ] Enable Rye Tool Management, like rye add\n- [ ] Folder Scanner for rye projects\n\n[XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html\n[platformdirs]: https://platformdirs.readthedocs.io/en/latest/\n[textual]: https://textual.textualize.io\n[pipx]: https://github.com/pypa/pipx\n[rye]: https://rye-up.com\n[PyPi]: https://pypi.org/project/rye-tui/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Rye meets Textual. Manage your python projects with a Tui",
"version": "0.5.1",
"project_urls": {
"Changelog": "https://github.com/Zaloog/rye-tui/blob/main/CHANGELOG.md",
"Repository": "https://github.com/Zaloog/rye-tui"
},
"split_keywords": [
"python",
" rye",
" textual",
" tui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c3f90d091477076f2f09e7d8c57d867ff4228e806855a51ddd5e62efdde8ae2",
"md5": "45469d6658855542f5d6262d8c2fde3e",
"sha256": "9b6b1fb127439573671140bef3d27d53d3b4b07259f9c76f55d0d4f45d314fe1"
},
"downloads": -1,
"filename": "rye_tui-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45469d6658855542f5d6262d8c2fde3e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 31134,
"upload_time": "2024-07-27T17:16:03",
"upload_time_iso_8601": "2024-07-27T17:16:03.141452Z",
"url": "https://files.pythonhosted.org/packages/3c/3f/90d091477076f2f09e7d8c57d867ff4228e806855a51ddd5e62efdde8ae2/rye_tui-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46d81f0d2a6874a90b1fde84129263b24208a502e4bf212bdefcb5549da7369b",
"md5": "5f4ee8e79a1e2f7bd12525d4cb332f6a",
"sha256": "4238dad8b430be5b0d0531d47e31e3c2853781e3df583f237aadcb7b258acb23"
},
"downloads": -1,
"filename": "rye_tui-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "5f4ee8e79a1e2f7bd12525d4cb332f6a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 414050,
"upload_time": "2024-07-27T17:16:05",
"upload_time_iso_8601": "2024-07-27T17:16:05.002729Z",
"url": "https://files.pythonhosted.org/packages/46/d8/1f0d2a6874a90b1fde84129263b24208a502e4bf212bdefcb5549da7369b/rye_tui-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-27 17:16:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Zaloog",
"github_project": "rye-tui",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rye-tui"
}
