Skip to content

Commit

Permalink
docs: prepare first release v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Midnighter committed Nov 22, 2024
1 parent 8d6537d commit a21b5b9
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
4 changes: 1 addition & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

- Upcoming features and fixes

## [0.1.0] - (1979-01-01)
## [0.1.0] - (2024-11-22)

- First release
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,32 @@

_A lightweight package that provides rate-limited httpx transports._

## Installation

The package is published on [PyPI](). Install it, for example, with

```sh
pip install httpx-limiter
```

## Usage

For situations when you need to make a large number of asynchronous request with a
controlled number of requests per time, you can apply rate limiting to an HTTPX client
using the provided transport. If you want to be able to make ten requests per second,
for example, use the following:

```python
import httpx
from httpx_limiter import AsyncRateLimitedTransport

async with httpx.AsyncClient(
transport=AsyncRateLimitedTransport.create(rate=10, capacity=10),
) as client:
...
```

## Copyright

- Copyright © 2024 Moritz E. Beber.
- Free software distributed under the [Apache Software License 2.0](./LICENSE).

0 comments on commit a21b5b9

Please sign in to comment.