Skip to main content

A post-modern terminal file explorer

Project description

rovr

Static Badge Static Badge Static Badge

[!caution] This project is in its very early stages. Feedback is appreciated, but this cannot be daily-driven yet.

What and Why?

  • What:
    • It is a file manager made using the Textual framework.
  • Why:
    • Because I can :3
    • I'm using this as a learning opportunity to learn more about Textual, and designing a neat little app for myself.

Screenshots

Startup Version 0.0.0.4

Create new Item Version 0.0.0.4

Delete selected items Version 0.0.0.4

Zoxide integration Version 0.0.0.4

Test run with uv

uvx --from git+https://github.com/NSPC911/rovr.git -q rovr --python 3.13

Install from PyPI's test server

# uv (my fav)
uv tool install rovr
# or pipx
pipx install rovr
# or plain old pip
pip install rovr

FAQ

  1. There isn't X theme/Why isn't Y theme available?
[[custom_theme]]
name = "<str>"
primary = "<hex>"
secondary = "<hex>"
success = "<hex>"
warning = "<hex>"
error = "<hex>"
accent = "<hex>"
foreground = "<hex>"
background = "<hex>"
surface = "<hex>"
panel = "<hex>"
is_dark = "<bool>"
variables = {
  "<key>" = "<value>"
}
  1. Why is it considered post-modern?
    • Parody to my current editor, helix
      • If NeoVim is considered modern, then Helix is post-modern
      • If superfile is considered modern, then rovr is post-modern
  2. Why did you say it cannot be daily driven?
    • Refer to the road map. There is many features yet to be completed. Pull Requests are appreciated
  3. What can I contribute?
    • Themes, and features can be contributed.
    • Refactors will be frowned on, and may take a longer time before merging
  4. I want to add a feature/theme/etc! How do I do so?
    • You need uv at minimum. pre-commit and ruff are recommended to be installed.
    • Clone the repo, and inside it, run uv sync and pre-commit install
    • Make your changes, ensure that your changes are properly formatted (via the pre-commit hook), before pushing to a custom branch on your fork
  5. How do I make a feature suggestion?
    • Open an issue using the feature-request tag. Issue templates will come soon.
  6. Why is it on test.pypi.org and not pypi.org
    • I need somewhere to act as a mini sadbox to learn more about pypi before I make any permenant mistakes in the actual app to be listed on the main pypi repository
  7. Why not ratatui or bubbletea??? angry noises
    • I like python.
  8. When will it be completed?
    • When it is completed.

Road map

This is a list of features that I plan to add before releasing the appropriate version and where they are inspired from.

Version 1

Status: 26/29

  • Directory Auto-completion (explorer)
  • Button Navigation (explorer)
  • Keyboard Navigation
    • Directory Navigation (explorer)
    • Others (superfile)
  • Double Click to enter into directories (explorer)
  • Configuration (superfile)
    • Base
    • Schema
    • Extending custom themes via configuration
  • zoxide support (ranger)
    There is no command line for rovr, which means it will use keybinds to launch either a modified current folder bar or a panel
  • Previewing image files using textual-image (superfile)
    Explorer kinda supports image viewing, but this is a TUI, so inspiration is from superfile
  • Previewing directories (superfile)
  • Pinned folder sidebar (superfile)
    Explorer also supports a pinned sidebar, but it also includes the massive file tree, which I won't add.
  • Search Bar (superfile)
  • Metadata
  • Clipboard (superfile)
    • Copy files and folders
    • Cut files and folders
    • Paste files and folders
      • Warn when overwriting same named files
  • Multiple File Lists
    • Tabs
    • Vertical and Horizontal Splits
  • Active and Completed processes (superfile)
  • Actions bar (explorer)
    • Change sort order of files
    • Copy files
    • Cut files
    • Paste files
    • Create new files/folders
    • Delete files/folders
    • Rename a file/folder
  • bat as previewer

Version 2

  • Plugins using pytest-dev/pluggy or a custom way (I wish not)
  • Cross process clipboard sync (two rovr instances should have synced clipboards)
  • Recycle Bin of 1-day when files get overwritten (Currently handled with sendtotrash but it doesn't work at times, so not a reliable solution)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rovr-0.0.3.post1.tar.gz (523.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rovr-0.0.3.post1-py3-none-any.whl (49.2 kB view details)

Uploaded Python 3

File details

Details for the file rovr-0.0.3.post1.tar.gz.

File metadata

  • Download URL: rovr-0.0.3.post1.tar.gz
  • Upload date:
  • Size: 523.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.5

File hashes

Hashes for rovr-0.0.3.post1.tar.gz
Algorithm Hash digest
SHA256 6429326097d7553aea41708b75b4f9e3897ef0897bec68c5b7d00d7a14cf4a47
MD5 3786445418836fd7eb7543216f956f83
BLAKE2b-256 a15c2129609229ee63bad8c0d5987fd5a84adcd1b4f7aca9330623ab7dc6f83d

See more details on using hashes here.

File details

Details for the file rovr-0.0.3.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for rovr-0.0.3.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 87345e89c63bd9eb68ac7e5d65914d4e3859e122205202e98c105d72f46dd0f6
MD5 6ad5a13c7de1ab360448819c45ef891f
BLAKE2b-256 0b59543befdfb568ee4e0c3fb6d31bd1041cd9ed01b23852c9a01d348323dc66

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page