zeroae / zeroae/zae-limiter

🎯 v1.0.0: Stable Release

Open
#49 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
0
Avg merge
6h 51m
Merged PRs (30d)
104

Description

v1.0.0: Stable Release

Theme: Production-ready stable API with complete documentation.

Milestone: v1.0.0

Goals

  1. Complete all pre-release milestones (v0.2.0 → v0.12.0)
  2. Remove all deprecated APIs
  3. Finalize documentation and test coverage

Remaining Tickets

Documentation: #39, #147, #148

Testing: #44

Cleanup:

  • Remove deprecated failure_mode parameter (renamed to on_unavailable in v0.9.0)
  • Remove deprecated cascade parameter from acquire() (moved to entity in v0.12.0)
  • Final API review

Success Criteria

  • All pre-release milestones completed
  • No deprecated APIs remain
  • All public APIs documented
  • Test coverage ≥ 80%
  • All CI checks pass
  • README includes production deployment checklist
  • CHANGELOG is complete
  • "Is this for you?" guide section added (#147)
  • Alternatives/comparison page added (#148)

Release Checklist

  • Final review of public API surface
  • Verify all deprecation warnings removed
  • Update pyproject.toml development status
  • Create release tag
  • Publish to PyPI

Backlog (Post v1.0.0)

Potential future enhancements based on user feedback:

  • Redis backend - For users needing sub-millisecond latency (note: current DynamoDB latency is 36-51ms p50, acceptable for LLM workloads but not for high-frequency API rate limiting)
  • LangChain/LiteLLM integration - First-party middleware for popular LLM frameworks
  • DAX support - Not viable: TransactWriteItems invalidates DAX cache on every acquire(), negating caching benefits

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the remaining milestones and tickets #39, #147, #148, and #44, then inspect pyproject.toml, README, and CHANGELOG against the release checklist. Done means the pre-release work is complete, deprecated APIs and warnings are removed, documentation and coverage meet the stated criteria, CI passes, and the package is ready for tagging and PyPI publication.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, release, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.