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.7.tar.gz (84.3 kB view details)

Uploaded Source

Built Distribution

anitui-0.1.7-py3-none-any.whl (89.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: anitui-0.1.7.tar.gz
  • Upload date:
  • Size: 84.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.6 Windows/10

File hashes

Hashes for anitui-0.1.7.tar.gz
Algorithm Hash digest
SHA256 4508d98008a6ab1d1bc1399e51787fe45eb33c7ad9b8ff6362c7959ced2a0afb
MD5 f94c2ff48fc5808609322d23db5acedd
BLAKE2b-256 6b083b21ed57ab1800e8353768a1e93021e44ee979f86193298bfacc070eb74d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: anitui-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 89.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.6 Windows/10

File hashes

Hashes for anitui-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 92ccde31bd84e9fb31dd588ace7615446984b2c2123803772987442973f6d76d
MD5 12431ee7fef6eb9e639c9569793496c5
BLAKE2b-256 312380ad27ced187ef77aafd26b11041ffa6653423178ec34e6e6bfcfc0ff24c

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