RSSingle/README.md

83 lines
1.6 KiB
Markdown
Raw Normal View History

2022-06-19 18:17:57 +02:00
# RSSingle
2022-06-19 18:17:57 +02:00
Generates an RSS file from the list of other feeds (RSS/Atom/JSON). Very handy when you want to centralise the list of your feeds in one place and all your devices feed from the same place.
2022-06-25 13:02:11 +02:00
<p align="center">
<img src="rssingle.png" width="200" alt="RRSingle">
</p>
2022-06-19 18:17:57 +02:00
## Run
2022-06-19 18:17:57 +02:00
1. Download the binary.
2022-06-19 18:50:33 +02:00
**Linux**
2022-06-19 18:49:15 +02:00
2022-06-19 18:17:57 +02:00
``` shell
2022-06-19 19:15:47 +02:00
wget https://github.com/tanrax/RSSingle/releases/download/v1.0.0/rssingle
2022-06-19 18:17:57 +02:00
```
2022-06-28 14:57:07 +02:00
**Windows**
2022-06-19 18:49:15 +02:00
2022-06-28 14:57:07 +02:00
``` shell
wget https://github.com/tanrax/RSSingle/releases/download/v1.0.0/rssingle.exe
```
2022-06-19 18:49:15 +02:00
2022-06-19 18:17:57 +02:00
2. Gives execution permissions.
2022-06-19 18:17:57 +02:00
``` shell
chmod +x rssingle
```
2022-06-19 18:17:57 +02:00
3. In the same directory as the binary, you can create a local `config.yml` file in this format:
2022-06-19 18:17:57 +02:00
``` yaml
title: My RSS Feed
description: My customised RSS feed with technology news
2022-06-19 18:40:31 +02:00
url: https://www.example.com
output: rss.xml
max_entries: 5 # Delete this line to get all
2022-06-19 18:17:57 +02:00
feeds:
- https://programadorwebvalencia.com/feed/
- https://republicaweb.es/feed/
```
2022-06-19 18:17:57 +02:00
If not, you can download the example in the repository.
2022-06-19 18:40:31 +02:00
``` shell
curl -o config.yml https://raw.githubusercontent.com/tanrax/RSSingle/master/config.yml
```
2022-06-19 18:17:57 +02:00
4. Run the binary.
2022-06-19 18:17:57 +02:00
``` shell
./rssingle
2022-06-19 18:17:57 +02:00
```
2022-06-19 18:17:57 +02:00
A file called `rss.xml` will be created.
2022-06-19 18:32:50 +02:00
## Development
Activate Debug messages by console.
```
export SR_LOG_LEVEl=DEBUG
```
2022-06-19 18:32:50 +02:00
### Compiling
```shell
pyinstaller --onefile rssingle.py
```
2022-06-19 19:43:04 +02:00
Old versions
```shell
docker run --rm --volume $PWD:/app python:3.8-buster /bin/bash -c "cd /app; pip3 install -r requirements.txt; pyinstaller --onefile rssingle.py"
```
2022-06-19 18:32:50 +02:00
You will find the binary in `dist`.
2022-06-19 18:17:57 +02:00
## Thanks
2022-06-19 18:40:31 +02:00
@shymega for his original project [singlerss](https://github.com/shymega/singlerss).