https://github.com/marcoceppi/python-spacetraders
A Python SpaceTraders library for interacting with the API
https://github.com/marcoceppi/python-spacetraders
asyncio python3 spacetraders spacetraders-api
Last synced: 21 days ago
JSON representation
A Python SpaceTraders library for interacting with the API
- Host: GitHub
- URL: https://github.com/marcoceppi/python-spacetraders
- Owner: marcoceppi
- Created: 2023-05-09T13:16:05.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-05T01:16:41.000Z (over 1 year ago)
- Last Synced: 2025-05-06T21:00:23.354Z (27 days ago)
- Topics: asyncio, python3, spacetraders, spacetraders-api
- Language: Python
- Homepage:
- Size: 781 KB
- Stars: 14
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# spacetraders python client
A client library for accessing SpaceTraders API
## Usage
First, create a client:
```python
from spacetraders import Client
client = Client(base_url="https://api.spacetraders.io/v2")
```
If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
```python
from spacetraders import AuthenticatedClient
client = AuthenticatedClient(base_url="https://api.spacetraders.io/v2", token="SuperSecretToken")
```
Now call your endpoint and use your models:
```python
from spacetraders.models import GetMyAgentResponse200
from spacetraders.types import Response
response: Response[GetMyAgentResponse200] = client.agents.get_my_agent()
```
Or do the same thing with an async version:
```python
from spacetraders.models import GetMyAgentResponse200
from spacetraders.types import Response
response: Response[GetMyAgentResponse200] = await client.agents.get_my_agent()
```
By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
```python
client = AuthenticatedClient(
base_url="https://internal_api.example.com",
token="SuperSecretToken",
verify_ssl="/path/to/certificate_bundle.pem",
)
```
You can also disable certificate validation altogether, but beware that **this is a security risk**.
```python
client = AuthenticatedClient(
base_url="https://internal_api.example.com",
token="SuperSecretToken",
verify_ssl=False
)
```
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. All path/query params and bodies become method arguments.
1. Tagged endpoints will use the first tag as a module name for the function
1. Any endpoint which did not have a tag will be in `client.default`
## Refreshing the API definition
This project is generated from [SpaceTradersAPI/api-docs](https://github.com/SpaceTradersAPI/api-docs/). The following steps outline how to refresh from a new schema:
1. Clone the version of the api-docs to be generated in another directory `git clone https://github.com/SpaceTradersAPI/api-docs /tmp/api-docs`
1. Navigate to `/tmp/api-docs` and generate a single OpenAPI bundle `npx @redocly/openapi-cli@latest bundle -o bundle.json`
1. In this projects directory, refresh the generated class with `poetry run openapi-python-client update --path /tmp/api-docs/bundle.json --meta none --config openapi-client.yml --custom-template-path=openapi-client-template`
## 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. 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`
1. Install that wheel from the other project `pip install `