Skip to content

Commit 0c537fd

Browse files
committed
documentation: update readme
1 parent 4a373f7 commit 0c537fd

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@
2323

2424
## Features
2525

26-
- TODO
26+
- Typed API client for api.checkedid.eu
2727

2828
## Requirements
2929

30-
- TODO
30+
- Build with Pydantic and httpx, does currently not support async.
3131

3232
## Installation
3333

@@ -39,7 +39,15 @@ $ pip install checkedid
3939

4040
## Usage
4141

42-
Please see the [Command-line Reference] for details.
42+
```py
43+
from checkedid import errors, models, Client
44+
45+
try:
46+
client = Client('1001')
47+
dossier: models.ReportResponse = client.dossier('123456789')
48+
except errors.CheckedIDNotFoundError as e:
49+
print("Dossier does not exists")
50+
```
4351

4452
## Contributing
4553

@@ -70,4 +78,3 @@ This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter]
7078

7179
[license]: https://github.com/foarsitter/checkedid-api-python-client/blob/main/LICENSE
7280
[contributor guide]: https://github.com/foarsitter/checkedid-api-python-client/blob/main/CONTRIBUTING.md
73-
[command-line reference]: https://checkedid-api-python-client.readthedocs.io/en/latest/usage.html

src/checkedid/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
"""CheckedID Python API client."""
2+
from .client import Client # noqa: F401

0 commit comments

Comments
 (0)