Skip to main content

A TUI to browse Anime

Project description

ani-tui

TUI written in Python using Textual to navigate local Anime files.

Showcase

GIF of AniTUI

Getting Started

Prerequisites

  • Python 3.9+

Install

To use ani-tui simply install the Python package:

Unix

pip3 install anitui

Windows

py -m pip install anitui

The TUI can then be run by simply typing anitui in the shell.

Connecting with VLC-Ani-Discord

ani-tui is capable of launching the vlc-ani-discord script along with your chosen media to display Discord Rich Presence and automatically update your Anilist episode progress. Note that this is only applicable if you are using VLC as your media player. The setup for this is a bit convoluted at the moment so it is automatically turned off. However, if you would like to use this feature here's how to do it! :)

  1. Find out where ani-tui was installed

    pip show anitui
    

    Here you should see something of the form:

    Location: {PATH}
    
  2. Go to the directory

    cd {PATH}/script
    
  3. Here you will find a README.md with instructions on setting up vlc-ani-discord. Complete the setup and then move on to Step 4

  4. Modify the ani-tui config file ~/.config/anitui/config.json in your chosen editor. Simply change "script": false to "script": true.

Then you're done! I will be improving this process to be more straightforward in the future.

Notes

Still in development, expect bugs! :)

License

MIT

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

anitui-0.1.6.tar.gz (86.1 kB view details)

Uploaded Source

Built Distribution

anitui-0.1.6-py3-none-any.whl (90.5 kB view details)

Uploaded Python 3

File details

Details for the file anitui-0.1.6.tar.gz.

File metadata

  • Download URL: anitui-0.1.6.tar.gz
  • Upload date:
  • Size: 86.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.5 Linux/5.18.11-200.fc36.x86_64

File hashes

Hashes for anitui-0.1.6.tar.gz
Algorithm Hash digest
SHA256 1b72bcdea23e7f28acf87fb64aace68f18c97c05ed1f0523e5d8b849f44b08e0
MD5 3f23d0b68302a90e69af49f7e9dffae7
BLAKE2b-256 b1825caed55862d4d709bfcb176c2d73f690923e58e4e1b0c562d1b55a574e07

See more details on using hashes here.

File details

Details for the file anitui-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: anitui-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 90.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.5 Linux/5.18.11-200.fc36.x86_64

File hashes

Hashes for anitui-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ca135395b96d871f82e6684e5a30470ab5c13e5324953d07ea3cfba89e09819b
MD5 460ce4d12cf25c23638ecbb0a596d6f1
BLAKE2b-256 4836900ff7337b5556287604a4829a39401d889e1478b0ca912c0d98a31120a2

See more details on using hashes here.

Supported by

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