Merge pull request #34 from foarsitter/development

documentation: update urls & readme

Author: foarsitter

.cookiecutter.json

@@ -9,6 +9,6 @@
   "github_user": "foarsitter",
   "license": "MIT",
   "package_name": "checkedid",
-  "project_name": "checkedid-python-client",
+  "project_name": "checkedid",
   "version": "0.1.0"
 }

CONTRIBUTING.md

@@ -12,9 +12,9 @@ Here is a list of important resources for contributors:
 - [Code of Conduct]
 
 [mit license]: https://opensource.org/licenses/MIT
-[source code]: https://github.com/foarsitter/checkedid-python-client
-[documentation]: https://checkedid-python-client.readthedocs.io/
-[issue tracker]: https://github.com/foarsitter/checkedid-python-client/issues
+[source code]: https://github.com/foarsitter/checkedid-api-python-client
+[documentation]: https://checkedid.readthedocs.io/
+[issue tracker]: https://github.com/foarsitter/checkedid-api-python-client/issues
 
 ## How to report a bug
 
@@ -54,7 +54,7 @@ or the command-line interface:
 
 ```console
 $ poetry run python
-$ poetry run checkedid-python-client
+$ poetry run checkedid
 ```
 
 [poetry]: https://python-poetry.org/
@@ -108,7 +108,7 @@ $ nox --session=pre-commit -- install
 It is recommended to open an issue before starting work on anything.
 This will allow a chance to talk it over with the owners and validate your approach.
 
-[pull request]: https://github.com/foarsitter/checkedid-python-client/pulls
+[pull request]: https://github.com/foarsitter/checkedid-api-python-client/pulls
 
 <!-- github-only -->
 

README.md

@@ -1,45 +1,53 @@
 # CheckedID Python API client
 
-[![PyPI](https://img.shields.io/pypi/v/checkedid-python-client.svg)][pypi_]
-[![Status](https://img.shields.io/pypi/status/checkedid-python-client.svg)][status]
-[![Python Version](https://img.shields.io/pypi/pyversions/checkedid-python-client)][python version]
-[![License](https://img.shields.io/pypi/l/checkedid-python-client)][license]
+[![PyPI](https://img.shields.io/pypi/v/checkedid.svg)][pypi_]
+[![Status](https://img.shields.io/pypi/status/checkedid.svg)][status]
+[![Python Version](https://img.shields.io/pypi/pyversions/checkedid)][python version]
+[![License](https://img.shields.io/pypi/l/checkedid)][license]
 
-[![Read the documentation at https://checkedid-python-client.readthedocs.io/](https://img.shields.io/readthedocs/checkedid-python-client/latest.svg?label=Read%20the%20Docs)][read the docs]
-[![Tests](https://github.com/foarsitter/checkedid-python-client/workflows/Tests/badge.svg)][tests]
-[![Codecov](https://codecov.io/gh/foarsitter/checkedid-python-client/branch/main/graph/badge.svg)][codecov]
+[![Read the documentation at https://checkedid.readthedocs.io/](https://img.shields.io/readthedocs/checkedid-api-python-client/latest.svg?label=Read%20the%20Docs)][read the docs]
+[![Tests](https://github.com/foarsitter/checkedid-api-python-client/workflows/Tests/badge.svg)][tests]
+[![Codecov](https://codecov.io/gh/foarsitter/checkedid-api-python-client/branch/main/graph/badge.svg)][codecov]
 
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
 [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
 
-[pypi_]: https://pypi.org/project/checkedid-python-client/
-[status]: https://pypi.org/project/checkedid-python-client/
-[python version]: https://pypi.org/project/checkedid-python-client
-[read the docs]: https://checkedid-python-client.readthedocs.io/
-[tests]: https://github.com/foarsitter/checkedid-python-client/actions?workflow=Tests
-[codecov]: https://app.codecov.io/gh/foarsitter/checkedid-python-client
+[pypi_]: https://pypi.org/project/checkedid/
+[status]: https://pypi.org/project/checkedid/
+[python version]: https://pypi.org/project/checkedid
+[read the docs]: https://checkedid.readthedocs.io/
+[tests]: https://github.com/foarsitter/checkedid-api-python-client/actions?workflow=Tests
+[codecov]: https://app.codecov.io/gh/foarsitter/checkedid-api-python-client
 [pre-commit]: https://github.com/pre-commit/pre-commit
 [black]: https://github.com/psf/black
 
 ## Features
 
-- TODO
+- Typed API client for api.checkedid.eu
 
 ## Requirements
 
-- TODO
+- Build with Pydantic and httpx, does currently not support async.
 
 ## Installation
 
 You can install _CheckedID Python API client_ via [pip] from [PyPI]:
 
 ```console
-$ pip install checkedid-python-client
+$ pip install checkedid
 ```
 
 ## Usage
 
-Please see the [Command-line Reference] for details.
+```py
+from checkedid import errors, models, Client
+
+try:
+    client = Client('1001')
+    dossier: models.ReportResponse = client.dossier('123456789')
+except errors.CheckedIDNotFoundError as e:
+    print("Dossier does not exists")
+```
 
 ## Contributing
 
@@ -63,11 +71,10 @@ This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter]
 [@cjolowicz]: https://github.com/cjolowicz
 [pypi]: https://pypi.org/
 [hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
-[file an issue]: https://github.com/foarsitter/checkedid-python-client/issues
+[file an issue]: https://github.com/foarsitter/checkedid-api-python-client/issues
 [pip]: https://pip.pypa.io/
 
 <!-- github-only -->
 
-[license]: https://github.com/foarsitter/checkedid-python-client/blob/main/LICENSE
-[contributor guide]: https://github.com/foarsitter/checkedid-python-client/blob/main/CONTRIBUTING.md
-[command-line reference]: https://checkedid-python-client.readthedocs.io/en/latest/usage.html
+[license]: https://github.com/foarsitter/checkedid-api-python-client/blob/main/LICENSE
+[contributor guide]: https://github.com/foarsitter/checkedid-api-python-client/blob/main/CONTRIBUTING.md

docs/index.md

@@ -19,5 +19,5 @@ reference
 contributing
 Code of Conduct <codeofconduct>
 License <license>
-Changelog <https://github.com/foarsitter/checkedid-python-client/releases>
+Changelog <https://github.com/foarsitter/checkedid-api-python-client/releases>
 ```

docs/usage.md

@@ -2,6 +2,6 @@
 
 ```{eval-rst}
 .. click:: checkedid.__main__:main
-    :prog: checkedid-python-client
+    :prog: checkedid
     :nested: full
 ```

pyproject.toml

@@ -5,9 +5,9 @@ description = "CheckedID Python API client"
 authors = ["Jelmer Draaijer <[email protected]>"]
 license = "MIT"
 readme = "README.md"
-homepage = "https://github.com/foarsitter/checkedid-python-client"
-repository = "https://github.com/foarsitter/checkedid-python-client"
-documentation = "https://checkedid-python-client.readthedocs.io"
+homepage = "https://github.com/foarsitter/checkedid-api-python-client"
+repository = "https://github.com/foarsitter/checkedid-api-python-client"
+documentation = "https://checkedid.readthedocs.io"
 packages = [
     { include = "checkedid", from = "src" },
 ]
@@ -16,7 +16,7 @@ classifiers = [
 ]
 
 [tool.poetry.urls]
-Changelog = "https://github.com/foarsitter/checkedid-python-client/releases"
+Changelog = "https://github.com/foarsitter/checkedid-api-python-client/releases"
 
 [tool.poetry.dependencies]
 python = "^3.7"

src/checkedid/__init__.py

@@ -1 +1,2 @@
 """CheckedID Python API client."""
+from .client import Client  # noqa: F401