Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Being able to subscribe to updates

Abierto
#577 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
12/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Activo
Área
api, backend

Línea de trabajo

This is a design question, not a patch: the issue asks whether catalog clients should subscribe to updates over SSE or websockets, and whether the payload should be ad hoc JSON or OPDS entries with a removal convention. Start with the earlier discussion in #265 and with how the current polling flow works for catalog retriever and the bittorrent tracker and seeder. Done means maintainers agree on a transport and format, not that code exists.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

pending clarification

Now that the Catalog is managed in a centralized DB/service, we should be able to get instant updates instead of relying on the old scheme of polling the API, checking if it has been updated, then parsing the whole thing. It was approached in #265.

That ticket was about stateless requests but there's a growing pattern of constantly watching catalog services:

  • catalog retriever (staging)
  • catalog retriever (prod)
  • bittorrent tracker
  • bittorrent seeder could work this way also.

For such catalog clients, being able to subscribe to updates would make a lot more sense. There are several ways to implement this but I believe SSE or even websocket are well suited for the transport part of this. SSE is simpler on both side of the connection and has this LastEventId concept so I'd look at it first.

Then there's the format, we could either use something adhoc (JSON) or send valid OPDS entries (which custom handling for removal).

Lenguaje dominante
Python
Estrellas
7
Forks
3
Merge medio
1 d 9 h
PR fusionados (30 d)
30

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de openzim/cms

Todos los issues de openzim/cms

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.