gleam-lang/gleam

Support use of a Hex API key to raise rate limits

Open

#3,651 opened on Sep 26, 2024

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (21,417 stars) (960 forks)batch import
help wantedhigh priority

Description

Otherwise many times gleam add wibble where wibble is different packages will result in

the rate limit for the Hex API has been exceeded for this IP

Contributor guide

Tech stack
rustshell
Domain
backendtoolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of RustUnderstanding of HTTP requestsFamiliarity with Gleam's package manager
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate how `gleam add` currently makes HTTP requests to the Hex API. Look in the Gleam codebase for client code (likely in the `src/` directory). Determine where to add an API key header from config or environment variable. Check if there is any existing configuration file parsing. Refer to Hex API documentation for rate limit headers and authentication. The issue mentions 'use of a Hex API key', so explore how to read keys from a config file or environment variable. Consider adding a command line flag or config option.
Support use of a Hex API key to raise rate limits · gleam-lang/gleam#3651 | Good First Issue