https://github.com/clabe45/zeddo
News CLI for lazy people
https://github.com/clabe45/zeddo
cli current events news tool
Last synced: 4 months ago
JSON representation
News CLI for lazy people
- Host: GitHub
- URL: https://github.com/clabe45/zeddo
- Owner: clabe45
- License: gpl-3.0
- Created: 2021-03-30T18:46:51.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-11T16:53:20.000Z (over 3 years ago)
- Last Synced: 2025-07-13T13:48:29.508Z (7 months ago)
- Topics: cli, current, events, news, tool
- Language: Python
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Zeddo
>News CLI for lazy people
Zeddo aggregates news from many different sources so you can stay up date
without leaving your terminal.
## Installation
```
pip install zeddo
```
## Set up
Create a [News API account](https://newsapi.org/register) and save the API key.
(You can choose the free plan.)
Then run `zeddo` and enter the API key when prompted.
## Usage
```
$ zeddo
[1] Public Protector finds procurement of 'scooter ambulances' was improper (News24)
[2] Businessinsider.co.za | Salaries for Ramaphosa, ministers set to remain unchanged – for the second year in a row (News24)
[3] JUST IN | SCA rules 2018 ANC Free State election 'unlawful and unconstitutional' (News24)
[4] Specialized's Turbo Como SL Is a Comfy, Lightweight Cruiser (Wired)
[5] 24 Times Teen Dramas Tried To Go Outside Their Genre And It Was Just So Weird (Buzzfeed)
Please enter an article number to open:
```
## Configuration
*Advanced usage:*
```
$ zeddo -h
Usage: zeddo [OPTIONS]
Options:
-k, --api-key TEXT API key for News API
-l, --language TEXT Filter articles by language
-t, --category TEXT Filter by category
-s, --search TEXT Search by key phrase
-n, --max-count INTEGER Limit number of articles
-v, --version Show the version and exit.
-h, --help Show this message and exit.
-c, --config FILE Read configuration from FILE.
```
*Example config file:*
```toml
api_key = ""
language = "en"
```
The location of the config file depends on the operating system:
- Mac OS X (not POSIX): `~/Library/Application Support/zeddo/config`
- Unix (not POSIX): `~/.config/zeddo/config`
- Mac OS X and Unix (POSIX): `~/.zeddo/config`
- Windows
- Roaming: `C:\Users\\AppData\Roaming\Foo Bar\config`
- Not roaming: `C:\Users\\AppData\Local\Foo Bar\config`
## License
Licensed under the GNU Public License v3.0