https://github.com/dee-me-tree-or-love/reading-list
Manage your reading list - for now using CLI! :books: Under maintenance: Project reboot is in progress...
https://github.com/dee-me-tree-or-love/reading-list
cli click python
Last synced: 9 days ago
JSON representation
Manage your reading list - for now using CLI! :books: Under maintenance: Project reboot is in progress...
- Host: GitHub
- URL: https://github.com/dee-me-tree-or-love/reading-list
- Owner: dee-me-tree-or-love
- Created: 2019-05-02T20:59:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-30T21:14:44.000Z (about 4 years ago)
- Last Synced: 2025-03-27T02:13:51.597Z (7 months ago)
- Topics: cli, click, python
- Language: Python
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Reading-List: CLI :books:
Manage your links to read using this CLI tool!
> Disclaimer: it's a work in progress, but do stay tuned ;)
## Getting started
For the time being the only way is to clone the repository.
### Basic usage
The easiest way to test the reading list out is to use the `cli` module:
```bash
$ python3 -m reading_list.cli.cli add \
--title "To Kill a Mockingbird" \
--link "https://en.wikipedia.org/wiki/To_Kill_a_Mockingbird"
Ok.
$ python3 -m reading_list.cli.cli list
-> To Kill a Mockingbird @ https://en.wikipedia.org/wiki/To_Kill_a_Mockingbird
```
#### Custom configuration files
It is also possible to provide a custom configuration file to override default behavior:
```bash
$ python3 -m reading_list.cli.cli \
--configuration "example_config.json" \
add \
--title "To Kill a Mockingbird" \
--link "https://en.wikipedia.org/wiki/To_Kill_a_Mockingbird"
Ok.
$ python3 -m reading_list.cli.cli \
--configuration "example_config.json" \
list
-> To Kill a Mockingbird @ https://en.wikipedia.org/wiki/To_Kill_a_Mockingbird
```
##### Supported configurations
> For the most up to date settings, see `reading_list/shared/config.py`
| Setting Path | `:=` | Description |
| ------------ | ---- | ----------- |
| `db.tiny_db.location` | `str:='db.json'` | A path for the TinyDB database file |
## Development
### Pre-Requisites
- [`Python 3.8+`](https://www.python.org/downloads/)
- [`make`](https://www.gnu.org/software/make/)
### Utilities
For a list of available utility scripts for this project,
check the [`Makefile`](./Makefile) contents.
#### Setup virtual environment
```bash
$ make venv
virtualenv .venv
created virtual environment ...
$ . .venv/bin/activate # or appropriate command for your system
```
#### Install requirements
```bash
$ make requirements-core # installs the main project requirements
$ make requirements-dev # installs the development dependencies
```
#### Testing
```bash
$ make test
pytest reading_list/ --doctest-modules -vvv
...
```
#### Lint & Type Checking
```bash
$ make flake8 # run the flake8 python style checks
$ make mypy # run the mypy type checker
$ make isort # run automated import sorting on all reading_list files (modifies files!)
```