978d09a7b495aa05def328ebf162f8b8077adfce
[planetlibre.git/.git] / README.md
1 # planetlibre
2 Simple RSS reader like a planet side.
3
4 # Lector simple de RSS
5
6 Este es un sencillo lector de RSS basado en python3. La lectura de las entradas se realiza de forma similar a un planet. Por defecto viene configurado con una serie de feeds para blogs que tratan sobre software libre.
7
8 # Instalación
9
10 Sólo hay que descargarlo e instalar el siguiente paquete:
11
12     sudo apt-get install feedparser
13
14 Después se ejecuta con:
15
16     python3 planet.py
17
18 # Salida generada
19
20 Una vez ejecutado el comando "python3 planet.py", se generará en la carpeta "salida" una serie de archivos html con las entradas leídas desde los blogs. Por defecto, se abrirá el navegador para comenzar a leer las entradas una vez finalizado el proceso.
21
22 # Modificación / introducción de nuevos blogs
23
24 Hay que modificar el archivo "blogs_feeds.txt" con los feeds de los blogs que se deseen añadir. Se debe colocar uno por línea.
25
26 # Actualización automática y subida a Github
27
28 El script "commit.sh" permite automatizar el proceso de generación de las entradas y subirlas a Github. Por seguridad se recomienda tener dos carpetas, en una se tendrán los archivos de este repositorio. En la otra se tendrá un repositorio personal que representará la página web que se desea que Github sirva en la web.
29
30 Se deben editar los parámetros de las primeras líneas del archivo "commit.sh". Los datos a rellenar vienen explicados en los comentarios.
31
32 Después se debe ejecutar el comando "crontab -e" para introducir cada cuanto se debe ejecutar "commit.sh". Por ejemplo, para ejecutarlo cada 12 horas, se escribirá:
33
34     0 */12 * * * bash /ruta-a-commit.sh/commit.sh