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

Provide convenience method for adding a client-id header

Abierto
#49 1 comentario 2 reacciones 0 asignados Ver en GitHub

@Sharvin-M ya está trabajando en esto.

Desde el 14/1/2025.

  • #97 de @Sharvin-M — abierto

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
api

Línea de trabajo

Empieza en la clase Query, junto a los métodos token y bearer_token existentes, y comprueba después cómo se expone la versión del paquete python_cmr. Se considera terminado cuando un método de conveniencia client_id establece Client-Id con el comportamiento solicitado para el valor predeterminado o el sufijo de versión, con cobertura tanto para los IDs proporcionados por el usuario como para los IDs predeterminados.

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

Descripción

enhancement good first issue

The Headers section of the CMR Search API documentation describes the Client-Id header as follows:

Client-Id - Indicates a name for the client using the CMR API. Specifying this helps Operations monitor query performance per client. It can also make it easier for them to identify your requests if you contact them for assistance.

Given that there are token and bearer_token methods in the Query class for conveniently setting the Authorization header, providing a client_id method would be convenient for supplying the Client-Id header.

Further, I recommend the following:

  • When the user does not invoke the client_id method to specify their own chosen ID for identification for assistance, a default should be set. I recommend something like this: python_cmr-vX.Y.Z, where X.Y.Z is the version of python_cmr
  • When the user does invoke the client_id method, the following suffix should be added to the value specified by the user: (python_cmr-vX.Y.Z), with a space character between the user-supplied value and the suffix.
Lenguaje dominante
Python
Estrellas
29
Forks
32
Merge medio
19 h 6 min
PR fusionados (30 d)
1

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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 nasa/python_cmr

Todos los issues de nasa/python_cmr

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.