<div align="center">
<h1>rovr</h1>
<img alt="Static Badge" src="https://img.shields.io/badge/Python-3.13-yellow?style=for-the-badge">
<img alt="Static Badge" src="https://img.shields.io/badge/made_with-textual-0b171d?style=for-the-badge&logoColor=yellow">
<!--python -c "import toml;print(len(toml.load('uv.lock')['package']))"-->
<img alt="Static Badge" src="https://img.shields.io/badge/Dependencies-73-purple?style=for-the-badge">
</div>
> [!caution]
> This project is in its very early stages. Feedback is appreciated, but this cannot be daily-driven yet.
<!--toc:start-->
- [What and Why?](#what-and-why)
- [Screenshots](#screenshots)
- [Test run with uv](#test-run-with-uv)
- [Install from PyPI's test server](#install-from-pypis-test-server)
- [FAQ](#faq)
- [Road map](#road-map)
- [Version 1](#version-1)
- [Version 2](#version-2)
<!--toc:end-->
### 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
<img alt="Version 0.0.0.4" src="https://github.com/NSPC911/rovr/blob/master/img/0.0.0.4/rovr_main.png?raw=true">
Create new Item
<img alt="Version 0.0.0.4" src="https://github.com/NSPC911/rovr/blob/master/img/0.0.0.4/rovr_new.png?raw=true">
Delete selected items
<img alt="Version 0.0.0.4" src="https://github.com/NSPC911/rovr/blob/master/img/0.0.0.4/rovr_delete.png?raw=true">
Zoxide integration
<img alt="Version 0.0.0.4" src="https://github.com/NSPC911/rovr/blob/master/img/0.0.0.4/rovr_zoxide.png?raw=true">
### Test run with uv
```pwsh
uvx --from git+https://github.com/NSPC911/rovr.git -q rovr --python 3.13
```
### Install from PyPI's test server
```pwsh
# uv (my fav)
uv tool install -i https://test.pypi.org/simple/ rovr
# or pipx
pipx install -i https://test.pypi.org/simple rovr
# or plain old pip
pip install -i https://test.pypi.org/simple/ rovr
```
### FAQ
1. There isn't X theme/Why isn't Y theme available?
- Textual's currently available themes are limited. However, extra themes can be added via the config file in the format below
- You can take a look at what each color represents in https://textual.textualize.io/guide/design/#base-colors<br>Inheriting themes will **not** be added.
```toml
[[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>"
```
2. Why is it considered post-modern?
- Parody to my current editor, [helix](https://helix-editor.com)
- If NeoVim is considered modern, then Helix is post-modern
- If superfile is considered modern, then rovr is post-modern
3. 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
4. What can I contribute?
- Themes, and features can be contributed.
- Refactors will be frowned on, and may take a longer time before merging
5. I want to add a feature/theme/etc! How do I do so?
- You need [uv](https://docs.astral.sh/uv) at minimum. [pre-commit](https://pre-commit.com/) and [ruff](https://docs.astral.sh/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
6. How do I make a feature suggestion?
- Open an issue using the `feature-request` tag. Issue templates will come soon.
7. Why is it on [test.pypi.org](https://test.pypi.org) and not [pypi.org](https://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
8. Why not ratatui or bubbletea??? <sub><i>angry noises</i></sub>
- I like python.
9. 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: 19/29
- [x] Directory Auto-completion (explorer)
- [x] Button Navigation (explorer)
- Keyboard Navigation
- [x] Directory Navigation (explorer)
- [ ] Others (superfile)
- [x] Double Click to enter into directories (explorer)
- Configuration (superfile)
- [x] Base
- [x] Schema
- [x] Extending custom themes via configuration
- [x] [zoxide](https://github.com/ajeetdsouza/zoxide) support (ranger)<br><sub>There is no command line for rovr, which means it will use keybinds to launch either a modified current folder bar or a panel</sub>
- [x] Previewing image files using [textual-image](https://github.com/lnqs/textual-image) (superfile)<br><sub>Explorer kinda supports image viewing, but this is a TUI, so inspiration is from superfile</sub>
- [x] Previewing directories (superfile)
- [x] Pinned folder sidebar (superfile)<br><sub>Explorer also supports a pinned sidebar, but it also includes the massive file tree, which I won't add.</sub>
- [ ] Search Bar (superfile)
- [x] Metadata
- Clipboard (superfile)
- [x] Copy files and folders
- [x] 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
- [x] Copy files
- [x] Cut files
- [ ] Paste files
- [x] Create new files/folders
- [x] Delete files/folders
- [x] Rename **a** file/folder
- [x] bat as previewer
#### Version 2
- [ ] Plugins using [pytest-dev/pluggy](https://github.com/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)
Raw data
{
"_id": null,
"home_page": null,
"name": "rovr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.13",
"maintainer_email": null,
"keywords": "filemanager, fs, python, textual, tui",
"author": "NSPC911",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c3/c3/09910f1b73746529e66f7ab62a2f988f505648411b9f45526c751be5fe92/rovr-0.0.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <h1>rovr</h1>\n <img alt=\"Static Badge\" src=\"https://img.shields.io/badge/Python-3.13-yellow?style=for-the-badge\">\n <img alt=\"Static Badge\" src=\"https://img.shields.io/badge/made_with-textual-0b171d?style=for-the-badge&logoColor=yellow\">\n <!--python -c \"import toml;print(len(toml.load('uv.lock')['package']))\"-->\n <img alt=\"Static Badge\" src=\"https://img.shields.io/badge/Dependencies-73-purple?style=for-the-badge\">\n</div>\n\n> [!caution]\n> This project is in its very early stages. Feedback is appreciated, but this cannot be daily-driven yet.\n\n<!--toc:start-->\n\n- [What and Why?](#what-and-why)\n- [Screenshots](#screenshots)\n- [Test run with uv](#test-run-with-uv)\n- [Install from PyPI's test server](#install-from-pypis-test-server)\n- [FAQ](#faq)\n- [Road map](#road-map)\n - [Version 1](#version-1)\n - [Version 2](#version-2)\n <!--toc:end-->\n\n### What and Why?\n\n- What:\n - It is a file manager made using the Textual framework.\n- Why:\n - Because I can :3\n - I'm using this as a learning opportunity to learn more about Textual, and designing a neat little app for myself.\n\n### Screenshots\n\nStartup\n<img alt=\"Version 0.0.0.4\" src=\"https://github.com/NSPC911/rovr/blob/master/img/0.0.0.4/rovr_main.png?raw=true\">\n\nCreate new Item\n<img alt=\"Version 0.0.0.4\" src=\"https://github.com/NSPC911/rovr/blob/master/img/0.0.0.4/rovr_new.png?raw=true\">\n\nDelete selected items\n<img alt=\"Version 0.0.0.4\" src=\"https://github.com/NSPC911/rovr/blob/master/img/0.0.0.4/rovr_delete.png?raw=true\">\n\nZoxide integration\n<img alt=\"Version 0.0.0.4\" src=\"https://github.com/NSPC911/rovr/blob/master/img/0.0.0.4/rovr_zoxide.png?raw=true\">\n\n### Test run with uv\n\n```pwsh\nuvx --from git+https://github.com/NSPC911/rovr.git -q rovr --python 3.13\n```\n\n### Install from PyPI's test server\n\n```pwsh\n# uv (my fav)\nuv tool install -i https://test.pypi.org/simple/ rovr\n# or pipx\npipx install -i https://test.pypi.org/simple rovr\n# or plain old pip\npip install -i https://test.pypi.org/simple/ rovr\n```\n\n### FAQ\n\n1. There isn't X theme/Why isn't Y theme available?\n - Textual's currently available themes are limited. However, extra themes can be added via the config file in the format below\n - You can take a look at what each color represents in https://textual.textualize.io/guide/design/#base-colors<br>Inheriting themes will **not** be added.\n\n```toml\n[[custom_theme]]\nname = \"<str>\"\nprimary = \"<hex>\"\nsecondary = \"<hex>\"\nsuccess = \"<hex>\"\nwarning = \"<hex>\"\nerror = \"<hex>\"\naccent = \"<hex>\"\nforeground = \"<hex>\"\nbackground = \"<hex>\"\nsurface = \"<hex>\"\npanel = \"<hex>\"\nis_dark = \"<bool>\"\n```\n\n2. Why is it considered post-modern?\n - Parody to my current editor, [helix](https://helix-editor.com)\n - If NeoVim is considered modern, then Helix is post-modern\n - If superfile is considered modern, then rovr is post-modern\n3. Why did you say it cannot be daily driven?\n - Refer to the road map. There is many features yet to be completed. Pull Requests are appreciated\n4. What can I contribute?\n - Themes, and features can be contributed.\n - Refactors will be frowned on, and may take a longer time before merging\n5. I want to add a feature/theme/etc! How do I do so?\n - You need [uv](https://docs.astral.sh/uv) at minimum. [pre-commit](https://pre-commit.com/) and [ruff](https://docs.astral.sh/ruff) are recommended to be installed.\n - Clone the repo, and inside it, run `uv sync` and `pre-commit install`\n - Make your changes, ensure that your changes are properly formatted (via the pre-commit hook), before pushing to a **custom** branch on your fork\n6. How do I make a feature suggestion?\n - Open an issue using the `feature-request` tag. Issue templates will come soon.\n7. Why is it on [test.pypi.org](https://test.pypi.org) and not [pypi.org](https://pypi.org)\n - 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\n8. Why not ratatui or bubbletea??? <sub><i>angry noises</i></sub>\n - I like python.\n9. When will it be completed?\n - When it is completed.\n\n### Road map\n\nThis is a list of features that I plan to add before releasing the appropriate version and where they are inspired from.\n\n#### Version 1\n\nStatus: 19/29\n\n- [x] Directory Auto-completion (explorer)\n- [x] Button Navigation (explorer)\n- Keyboard Navigation\n - [x] Directory Navigation (explorer)\n - [ ] Others (superfile)\n- [x] Double Click to enter into directories (explorer)\n- Configuration (superfile)\n - [x] Base\n - [x] Schema\n - [x] Extending custom themes via configuration\n- [x] [zoxide](https://github.com/ajeetdsouza/zoxide) support (ranger)<br><sub>There is no command line for rovr, which means it will use keybinds to launch either a modified current folder bar or a panel</sub>\n- [x] Previewing image files using [textual-image](https://github.com/lnqs/textual-image) (superfile)<br><sub>Explorer kinda supports image viewing, but this is a TUI, so inspiration is from superfile</sub>\n- [x] Previewing directories (superfile)\n- [x] Pinned folder sidebar (superfile)<br><sub>Explorer also supports a pinned sidebar, but it also includes the massive file tree, which I won't add.</sub>\n- [ ] Search Bar (superfile)\n- [x] Metadata\n- Clipboard (superfile)\n - [x] Copy files and folders\n - [x] Cut files and folders\n - [ ] Paste files and folders\n - [ ] Warn when overwriting same named files\n- Multiple File Lists\n - [ ] Tabs\n - [ ] Vertical and Horizontal Splits\n- [ ] Active and Completed processes (superfile)\n- Actions bar (explorer)\n - [ ] Change sort order of files\n - [x] Copy files\n - [x] Cut files\n - [ ] Paste files\n - [x] Create new files/folders\n - [x] Delete files/folders\n - [x] Rename **a** file/folder\n- [x] bat as previewer\n\n#### Version 2\n\n- [ ] Plugins using [pytest-dev/pluggy](https://github.com/pytest-dev/pluggy) or a custom way (I wish not)\n- [ ] Cross process clipboard sync (two rovr instances should have synced clipboards)\n- [ ] 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)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A post-modern terminal file explorer",
"version": "0.0.1",
"project_urls": {
"Issues": "https://github.com/NSPC911/rovr/issues",
"Source": "https://github.com/NSPC911/rovr"
},
"split_keywords": [
"filemanager",
" fs",
" python",
" textual",
" tui"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d91a02d0d600fad4ffcfd018e171453deb3632be664c162fb99b34e2a6438661",
"md5": "29e6e27c05763ba67dc30fa12b5059d9",
"sha256": "0e9c232e1b1736f1012e90fdc8ce66e30b6df68c86daa4df93235ba98be5a00e"
},
"downloads": -1,
"filename": "rovr-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29e6e27c05763ba67dc30fa12b5059d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13",
"size": 45871,
"upload_time": "2025-07-30T15:38:39",
"upload_time_iso_8601": "2025-07-30T15:38:39.995008Z",
"url": "https://files.pythonhosted.org/packages/d9/1a/02d0d600fad4ffcfd018e171453deb3632be664c162fb99b34e2a6438661/rovr-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c3c309910f1b73746529e66f7ab62a2f988f505648411b9f45526c751be5fe92",
"md5": "05b9cbbf2b579c490f185bdee13e434f",
"sha256": "dcd610bd8b32ee558909b001538aff8c8b8e5e54bb0fb520f6e6f78b445013f4"
},
"downloads": -1,
"filename": "rovr-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "05b9cbbf2b579c490f185bdee13e434f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13",
"size": 520036,
"upload_time": "2025-07-30T15:38:42",
"upload_time_iso_8601": "2025-07-30T15:38:42.877879Z",
"url": "https://files.pythonhosted.org/packages/c3/c3/09910f1b73746529e66f7ab62a2f988f505648411b9f45526c751be5fe92/rovr-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 15:38:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NSPC911",
"github_project": "rovr",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "aiohappyeyeballs",
"specs": [
[
"==",
"2.6.1"
]
]
},
{
"name": "aiohttp",
"specs": [
[
"==",
"3.12.14"
]
]
},
{
"name": "aiohttp-jinja2",
"specs": [
[
"==",
"1.6"
]
]
},
{
"name": "aiosignal",
"specs": [
[
"==",
"1.4.0"
]
]
},
{
"name": "argcomplete",
"specs": [
[
"==",
"3.6.2"
]
]
},
{
"name": "attrs",
"specs": [
[
"==",
"25.3.0"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.4.2"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.2.1"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "commitizen",
"specs": [
[
"==",
"4.8.3"
]
]
},
{
"name": "decli",
"specs": [
[
"==",
"0.6.3"
]
]
},
{
"name": "frozenlist",
"specs": [
[
"==",
"1.7.0"
]
]
},
{
"name": "future",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "humanize",
"specs": [
[
"==",
"4.12.3"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.10"
]
]
},
{
"name": "importlib-metadata",
"specs": [
[
"==",
"8.7.0"
]
]
},
{
"name": "jinja2",
"specs": [
[
"==",
"3.1.6"
]
]
},
{
"name": "linkify-it-py",
"specs": [
[
"==",
"2.0.3"
]
]
},
{
"name": "lzstring",
"specs": [
[
"==",
"1.0.4"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "markupsafe",
"specs": [
[
"==",
"3.0.2"
]
]
},
{
"name": "mdit-py-plugins",
"specs": [
[
"==",
"0.4.2"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "msgpack",
"specs": [
[
"==",
"1.1.1"
]
]
},
{
"name": "multidict",
"specs": [
[
"==",
"6.6.3"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"25.0"
]
]
},
{
"name": "pastel",
"specs": [
[
"==",
"0.2.1"
]
]
},
{
"name": "pillow",
"specs": [
[
"==",
"11.3.0"
]
]
},
{
"name": "platformdirs",
"specs": [
[
"==",
"4.3.8"
]
]
},
{
"name": "poethepoet",
"specs": [
[
"==",
"0.36.0"
]
]
},
{
"name": "prompt-toolkit",
"specs": [
[
"==",
"3.0.51"
]
]
},
{
"name": "propcache",
"specs": [
[
"==",
"0.3.2"
]
]
},
{
"name": "psutil",
"specs": [
[
"==",
"7.0.0"
]
]
},
{
"name": "pygments",
"specs": [
[
"==",
"2.19.2"
]
]
},
{
"name": "pyyaml",
"specs": [
[
"==",
"6.0.2"
]
]
},
{
"name": "questionary",
"specs": [
[
"==",
"2.1.0"
]
]
},
{
"name": "rapidfuzz",
"specs": [
[
"==",
"3.13.0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"14.1.0"
]
]
},
{
"name": "ruff",
"specs": [
[
"==",
"0.12.5"
]
]
},
{
"name": "send2trash",
"specs": [
[
"==",
"1.8.3"
]
]
},
{
"name": "termcolor",
"specs": [
[
"==",
"3.1.0"
]
]
},
{
"name": "textual",
"specs": [
[
"==",
"4.0.0"
]
]
},
{
"name": "textual-autocomplete",
"specs": [
[
"==",
"4.0.4"
]
]
},
{
"name": "textual-dev",
"specs": [
[
"==",
"1.7.0"
]
]
},
{
"name": "textual-image",
"specs": [
[
"==",
"0.8.3"
]
]
},
{
"name": "textual-serve",
"specs": [
[
"==",
"1.1.2"
]
]
},
{
"name": "thefuzz",
"specs": [
[
"==",
"0.22.1"
]
]
},
{
"name": "toml",
"specs": [
[
"==",
"0.10.2"
]
]
},
{
"name": "tomlkit",
"specs": [
[
"==",
"0.13.3"
]
]
},
{
"name": "tree-sitter",
"specs": [
[
"==",
"0.24.0"
]
]
},
{
"name": "tree-sitter-bash",
"specs": [
[
"==",
"0.25.0"
]
]
},
{
"name": "tree-sitter-css",
"specs": [
[
"==",
"0.23.2"
]
]
},
{
"name": "tree-sitter-go",
"specs": [
[
"==",
"0.23.4"
]
]
},
{
"name": "tree-sitter-html",
"specs": [
[
"==",
"0.23.2"
]
]
},
{
"name": "tree-sitter-java",
"specs": [
[
"==",
"0.23.5"
]
]
},
{
"name": "tree-sitter-javascript",
"specs": [
[
"==",
"0.23.1"
]
]
},
{
"name": "tree-sitter-json",
"specs": [
[
"==",
"0.24.8"
]
]
},
{
"name": "tree-sitter-markdown",
"specs": [
[
"==",
"0.3.2"
]
]
},
{
"name": "tree-sitter-python",
"specs": [
[
"==",
"0.23.6"
]
]
},
{
"name": "tree-sitter-regex",
"specs": [
[
"==",
"0.24.3"
]
]
},
{
"name": "tree-sitter-rust",
"specs": [
[
"==",
"0.23.2"
]
]
},
{
"name": "tree-sitter-sql",
"specs": [
[
"==",
"0.3.7"
]
]
},
{
"name": "tree-sitter-toml",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "tree-sitter-xml",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "tree-sitter-yaml",
"specs": [
[
"==",
"0.7.1"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
"==",
"4.14.1"
]
]
},
{
"name": "uc-micro-py",
"specs": [
[
"==",
"1.0.3"
]
]
},
{
"name": "ujson",
"specs": [
[
"==",
"5.10.0"
]
]
},
{
"name": "watchdog",
"specs": [
[
"==",
"6.0.0"
]
]
},
{
"name": "wcwidth",
"specs": [
[
"==",
"0.2.13"
]
]
},
{
"name": "yarl",
"specs": [
[
"==",
"1.20.1"
]
]
},
{
"name": "zipp",
"specs": [
[
"==",
"3.23.0"
]
]
}
],
"lcname": "rovr"
}
