Skip to content

Commit c13f961

Browse files
committed
Add simplified README for PyPI
1 parent 8a7607a commit c13f961

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README-pypi.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# REST-RPC
2+
3+
REST-RPC is a Python library that makes writing type-checked REST APIs easy (by allowing you to define your API once and use it on both the server and the client).
4+
5+
It automatically creates convenient front-end bindings to your API for you, so from the front-end developer's perspective it's indistinguishable from an RPC library, hence the name.
6+
7+
REST-RPC's type-checking is based on Pydantic. For the back-end, it used FastAPI. For the front-end, it supports `requests`, `urllib3`, `httpx`, and `aiohttp` (or provide your own transport layer). If you want to use REST-RPC in the webbrowser, you can: It supports `pyodide`'s `pyfetch` and `pyscript`'s `fetch`!
8+
This means that the only "hard" dependency is `pydantic`. Of course, you'll need FastAPI in the back-end and one of the mentioned HTTP libraries for the front-end.
9+
10+
REST-RPC is for you, if you:
11+
- …like FastAPI and Pydantic.
12+
- …just want to write simple type-checked REST APIs without frills.
13+
- …don't want to repeat yourself when writing the front-end code.
14+
15+
Visit the [GitHub page](https://github.com/felsenhower/rest-rpc) for more information.
16+
17+

0 commit comments

Comments
 (0)