Skip to content
/ rye-tui Public

A Text-based User Interface (Tui) for rye powered by Textual

License

Notifications You must be signed in to change notification settings

Zaloog/rye-tui

Repository files navigation

Rye PyPI-Server Pyversions Licence Downloads

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.

header_image

Currently still under development

For a list of missing features check the Open Points below

Installation

You can already install a first release with one of the three options:

pip install rye-tui
pipx install rye-tui
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

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. The Edit- Button can be used to open and edit the pyproject.toml from within the TUI. project_image

rye add and rye add --dev is already supported, flags are still missing currently. add_image

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. general_image

Config Tab

The Config Tab can be used to change rye's underlying config and add or delete additional sources. config_image

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 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