profitroll/PhotosAPI_Client
profitroll/PhotosAPI_Client
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Releases 5 Activity

Improved MD compliance

Browse Source
This commit is contained in:
Profitroll 2023-11-25 20:20:15 +01:00
parent a4f6bb2a25
commit a1c41cbd17
Signed by: profitroll
GPG Key ID: FA35CAB49DACD3B2
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,7 +1,9 @@
# PhotosAPI_Client # PhotosAPI_Client
A client library for accessing Photos API A client library for accessing Photos API
## Usage ## Usage
First, create a client: First, create a client:
```python ```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. 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: Things to know:
1. Every path/method combo becomes a Python module with four functions: 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`: 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. 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` 1. Any endpoint which did not have a tag will be in `photosapi_client.api.default`
## Building / publishing this Client ## Building / publishing this Client
This project uses [Poetry](https://python-poetry.org/) to manage dependencies and packaging. Here are the basics: 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. Update the metadata in pyproject.toml (e.g. authors, version)
1. If you're using a private repository, configure it with Poetry 1. If you're using a private repository, configure it with Poetry
1. `poetry config repositories.<your-repository-name> <url-to-your-repository>` 1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
@ -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 <your-repository-name>` or, if for public PyPI, just `poetry publish --build` 1. Publish the client with `poetry publish --build -r <your-repository-name>` 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: 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 <path-to-this-client>` from that project 1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
1. If that project is not using Poetry: 1. If that project is not using Poetry:
1. Build a wheel with `poetry build -f wheel` 1. Build a wheel with `poetry build -f wheel`