From a1c41cbd175e12b2f69408a7ef16d3e7eeb2afa1 Mon Sep 17 00:00:00 2001 From: profitroll Date: Sat, 25 Nov 2023 20:20:15 +0100 Subject: [PATCH] Improved MD compliance --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 2a76a61..04a4e18 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # PhotosAPI_Client + A client library for accessing Photos API ## Usage + First, create a client: ```python @@ -64,6 +66,7 @@ client = AuthenticatedClient( There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. Things to know: + 1. Every path/method combo becomes a Python module with four functions: 1. `sync`: Blocking request that returns parsed data (if successful) or `None` 1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful. @@ -75,7 +78,9 @@ Things to know: 1. Any endpoint which did not have a tag will be in `photosapi_client.api.default` ## Building / publishing this Client + This project uses [Poetry](https://python-poetry.org/) to manage dependencies and packaging. Here are the basics: + 1. Update the metadata in pyproject.toml (e.g. authors, version) 1. If you're using a private repository, configure it with Poetry 1. `poetry config repositories. ` @@ -83,6 +88,7 @@ This project uses [Poetry](https://python-poetry.org/) to manage dependencies a 1. Publish the client with `poetry publish --build -r ` or, if for public PyPI, just `poetry publish --build` If you want to install this client into another project without publishing it (e.g. for development) then: + 1. If that project **is using Poetry**, you can simply do `poetry add ` from that project 1. If that project is not using Poetry: 1. Build a wheel with `poetry build -f wheel`