Skip to content

Commit

Permalink
OPT: improve the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
eigenein committed Nov 7, 2023
1 parent 756ca76 commit 94ff459
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 18 deletions.
9 changes: 0 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,6 @@ declared by a [protocol](https://peps.python.org/pep-0544/) class or an abstract
[![Python Version](https://img.shields.io/pypi/pyversions/combadge?logo=python&logoColor=yellow)](https://pypi.org/project/combadge/)
[![License](https://img.shields.io/github/license/kpn/combadge)](LICENSE)

## Features

- Request and response models based on [**Pydantic**](https://docs.pydantic.dev/)
- Declarative services using [`Protocol`](https://peps.python.org/pep-0544/)
- Exception classes automatically derived from error models
- Built-in backends:
- [HTTPX](https://www.python-httpx.org/) – sync and async
- [Zeep](https://docs.python-zeep.org/en/master/) – sync and async

## Documentation

<a href="https://kpn.github.io/combadge/">
Expand Down
9 changes: 0 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,6 @@ declared by a [protocol](https://peps.python.org/pep-0544/) class or an abstract
[![Python Version](https://img.shields.io/pypi/pyversions/combadge?logo=python&logoColor=yellow)](https://pypi.org/project/combadge/)
![License](https://img.shields.io/github/license/kpn/combadge)

## Features

- Request and response models based on [**Pydantic**](https://docs.pydantic.dev/)
- Declarative services using [`Protocol`](https://peps.python.org/pep-0544/)
- Exception classes automatically derived from error models
- Built-in backends:
- [HTTPX](https://www.python-httpx.org/) – sync and async
- [Zeep](https://docs.python-zeep.org/en/master/) – sync and async

## Sneak peek

=== "With HTTPX"
Expand Down

0 comments on commit 94ff459

Please sign in to comment.