https://github.com/regseb/gout
Agrégateur d'Internet (flux RSS et tout le reste).
https://github.com/regseb/gout
aggregator atom feed gout javascript news reader rss scraper widget
Last synced: over 1 year ago
JSON representation
Agrégateur d'Internet (flux RSS et tout le reste).
- Host: GitHub
- URL: https://github.com/regseb/gout
- Owner: regseb
- License: mit
- Created: 2013-11-23T11:24:52.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2024-08-11T14:47:41.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T00:54:45.054Z (over 1 year ago)
- Topics: aggregator, atom, feed, gout, javascript, news, reader, rss, scraper, widget
- Language: JavaScript
- Homepage: https://github.com/regseb/gout
- Size: 2.72 MB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Gout
[![firefox][img-firefox]][link-firefox] [![build][img-build]][link-build]
[![coverage][img-coverage]][link-coverage]
> Agrégateur d'Internet (flux RSS et tout le reste).
## Description
Gout est une **extension** Firefox pour récupérer des informations sur Internet
(flux RSS, résultats d'API, parsing de sites Internet...) et les afficher dans
une page Web. Les [dashboards](#dashboard) sont ces pages Web avec du
[YAML](https://yaml.org/ "YAML Ain't Markup Language") pour configurer chaque
[widget](#widget). La configuration d'un widget comporte un [module](#module)
pour définir le format d'affichage ; et des [scrapers](#scraper) pour extraire
des données.
## Démarrage rapide
- Installez l'extension Gout depuis le [**Firefox Browser
Add-ons**][link-firefox].
- Téléchargez et décompressez le zip
[`gout-dashboard-example.zip`](examples/gout-dashboard-example.zip).
- Ouvrez le fichier `gout-dashboard-example/index.html` dans Firefox.
- Ouvrez la popup de l'extension Gout et activez Gout pour la page courant.
- Découvrez les widgets qui s'affichent.
## Composants
### Dashboard
Un dashboard est une page Web qui contient des widgets. Elle doit importer le
moteur de rendu de Gout :
`"https://cdn.jsdelivr.net/gh/regseb/gout@0/src/engine/script.js"`.
Voici un exemple de dashboard ayant quatre colonnes de widgets.
```html
Gout
body {
display: flex;
}
div {
display: flex;
flex-direction: column;
}
# ...
# ...
# ...
# ...
# ...
# ...
```
### Widget
Un widget est un bloc du dashboard. C'est un élément `` (avec le
`type="application/yaml"`). Le widget sera ajouté dans le DOM de la page au même
endroit que l'élément `<script>`. Le contenu du `<script>` est au format
[YAML](https://yaml.org/ "YAML Ain't Markup Language") avec les propriétés :
```yaml
module:
url: # L'URL du fichier JavaScript du module.
options: # Les options du module.
scrapers:
- url: # L'URL du fichier JavaScript du premier scraper.
options: # Les options du premier scraper.
- url: # L'URL du fichier JavaScript du deuxième scraper.
options: # Les options du deuxième scraper.
# ...
```
Cet exemple de widget récupère les dernières publications du flux RSS du site
[LinuxFr.org](https://linuxfr.org/) et il les affiche sous forme d'une liste de
liens.
```html
<script type="application/yaml">
module:
url: "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/module/list/list.js"
options:
cron: "0 * * * *"
max: 5
color: "#ffc107"
scrapers:
- url: "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/scraper/list/rss/rss.js"
options:
url: "https://linuxfr.org/news.atom"
```
Vous pouvez aussi importer des widgets directement dans votre dashboard. Il faut
ajouter un élément `` avec l'attribut `src` (ainsi que le `type`). Dans
l'exemple ci-dessous, le widget permettant d'écouter la radio
[Fip](https://github.com/regseb/gout-regseb/tree/main/src/widget/radiofrance#readme)
est intégré dans le dashboard :
```html
<script
type="application/yaml"
src="https://cdn.jsdelivr.net/gh/regseb/gout-regseb@0/src/widget/radiofrance/fip.yaml"
>
```
Si vous voulez des widgets, vous pouvez chercher
[_gout-widget_](https://github.com/search?q=%22+gout-widget%22+language%3AMarkdown&type=Code&l=Markdown)
dans GitHub.
### Module
Les modules sont les composants des widgets définissant comment les données sont
affichées (une liste de liens, une image...). La configuration d'un module a
trois propriétés :
- `url` : L'URL du fichier JavaScript du module (par exemple pour le module
[_list_](src/module/list#readme) :
`"https://cdn.jsdelivr.net/gh/regseb/gout@0/src/module/list/list.js"`).
- `options` : Les options du module (qui sont spécifiques pour chaque module).
- `scrapers` : La liste des [scrapers](#scraper) associés au module.
Dans cet exemple, le module est une liste (avec au maximum `5` éléments)
affichée dans un bloc bleu `#2196f3` et actualisée toutes les dix minutes
[`*/10 * * * *`](https://crontab.guru/#*/10_*_*_*_*).
```html
module:
url: "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/module/list/list.js"
options:
cron: "*/10 * * * *"
max: 5
color: "#2196f3"
scrapers: # ...
```
Si vous voulez des modules, vous pouvez chercher
[_gout-module_](https://github.com/search?q=%22+gout-module%22+language%3AMarkdown&type=Code&l=Markdown)
dans GitHub.
### Scraper
Les scrapers permettent d'extraire des données (flux RSS, parsing de page...) et
de les transmettre à un module dans un format spécifique. Plusieurs scrapers
peuvent être associés avec un module. Dans la configuration du widget, les
scrapers sont définis dans une liste ou chaque élément a deux propriétés :
- `url` : L'URL du fichier JavaScript du scraper (par exemple pour le scraper
[_list/rss_](src/scraper/list/rss#readme) :
`"https://cdn.jsdelivr.net/gh/regseb/gout@0/src/scraper/list/rss/rss.js"`).
- `options` : Les options du scraper (qui sont spécifiques pour chaque scraper).
Dans cet exemple, deux scrapers sont définis pour récupérer les dernières vidéos
des chaines YouTube [ARTE Cinema](https://www.youtube.com/@artecinemafr) et
[ARTE Séries](https://www.youtube.com/@arteseries).
```html
module:
url: # ...
options: # ...
scrapers
- url: "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/scraper/list/rss/rss.js"
options:
url: "https://www.youtube.com/feeds/videos.xml?channel_id=UClo03hULFynpoX3w1Jv7fhw"
- url: "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/scraper/list/rss/rss.js"
options:
url: "https://www.youtube.com/feeds/videos.xml?channel_id=UCzaf-8cAEiXfynukcmV5MXw"
```
Si vous voulez des scrapers, vous pouvez chercher
[_gout-scraper_](https://github.com/search?q=%22+gout-scraper%22+language%3AMarkdown&type=Code&l=Markdown)
dans GitHub.
[img-firefox]:
https://img.shields.io/amo/v/gout.svg?label=add-on&logo=firefox-browser&logoColor=whitesmoke
[img-build]:
https://img.shields.io/github/actions/workflow/status/regseb/gout/ci.yml?branch=main&logo=github&logoColor=whitesmoke
[img-coverage]:
https://img.shields.io/endpoint?label=coverage&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fregseb%2Fgout%2Fmain
[link-firefox]: https://addons.mozilla.org/addon/gout/
[link-build]:
https://github.com/regseb/gout/actions/workflows/ci.yml?query=branch%3Amain
[link-coverage]:
https://dashboard.stryker-mutator.io/reports/github.com/regseb/gout/main