mirror/castero
1
0
Fork 0
mirror of https://github.com/xgi/castero synced 2024-11-10 15:28:45 +01:00
Code Issues
TUI podcast client for the terminal
305 Commits 1 Branch 29 Tags 1.5 MiB
Python 100%
v0.6.0
Go to file
Jake Robertson 54906efd7d
increment to version 0.6.0
2019-06-10 21:37:22 -04:00
.circleci add CircleCI python 3.5 test 2019-03-25 13:46:34 -04:00
castero increment to version 0.6.0 2019-06-10 21:37:22 -04:00
res replace with smaller screenshot 2018-04-08 11:44:17 -04:00
tests add tests for subscriptions model 2019-06-09 19:22:17 -04:00
_config.yml Set theme jekyll-theme-cayman 2018-04-14 12:52:29 -04:00
.flake8 add flake8 config & resolve some minor warnings 2018-05-04 11:48:51 -04:00
.gitignore initial 2018-04-06 22:14:24 -04:00
CHANGELOG.md increment to version 0.6.0 2019-06-10 21:37:22 -04:00
LICENSE.txt initial 2018-04-06 22:14:24 -04:00
README.md add playback controls to help menu 2019-06-07 16:22:09 -04:00
requirements.txt add all test/install deps to requirements.txt 2019-03-02 16:35:17 -05:00
setup.cfg update setup.py args in preparation for pypi upload 2018-04-13 17:04:52 -04:00
setup.py fix setup.py data & increment to 0.5.3 2019-03-19 21:08:05 -04:00

README.md

castero

GitHub release PyPI CircleCI Codacy Grade Codacy Coverage

castero is a TUI podcast client for the terminal.

example client screenshot

Installation

Install from PyPi with pip:

$ pip install castero

Upgrading:

$ pip install castero --upgrade

Manual Installation

Warning: changes to the master branch are sometimes made before the documentation on this page is updated.

$ git clone https://github.com/xgi/castero
$ cd castero
$ sudo python setup.py install

Dependencies

Running castero requires the following external dependencies:

  • Python >= 3.5 (check the output of python --version)
  • sqlite3
  • One of the following media players:
    • vlc >= 2.2.3
    • (mpv and libmpv) >= 0.14.0

Usage

After installing castero, it can be run with simply:

$ castero

The help menu provides a list of controls and can be accessed by pressing h. Alternatively, see the list below:

Commands
    h            - show this help screen
    q            - exit the client
    a            - add a feed
    d            - delete the selected feed
    r            - reload/refresh feeds
    s            - save episode for offline playback
    arrows       - navigate menus
    page up/down - scroll menus
    enter        - play selected feed/episode
    space        - add selected feed/episode to queue
    c            - clear the queue
    n            - go to the next episode in the queue
    i            - invert the order of the menu
    p or k       - pause/play the current episode
    f or l       - seek forward
    b or j       - seek backward
    ]            - increase playback speed
    [            - decrease playback speed
    1-3          - change between client layouts

Configuration

The configuration file is located at {HOME}/.config/castero/castero.conf after the client has been run at least once.

Please see the default castero.conf for a list of available settings.

User data, including downloaded episodes and a database with your feed information, is located at {HOME}/.local/share/castero/. These files are not intended to be manually modified. Removing the database will simply cause castero to replace it with an empty one the next time you run the client.

Testing

This project uses pytest for testing. To run tests, run the following command in the project's root directory:

$ python -m pytest tests

You can also run tests for an individual unit, i.e.:

$ python -m pytest tests/test_feed.py

License

MIT License