Skip to main content

Python API for Space Traders

Project description

spacetraders python client

A client library for accessing SpaceTraders API

Usage

First, create a client:

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:

from spacetraders import AuthenticatedClient

client = AuthenticatedClient(base_url="https://api.spacetraders.io/v2", token="SuperSecretToken")

Now call your endpoint and use your models:

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:

from spacetraders.models import GetMyAgentResponse200
from spacetraders.types import Response

response: Response[MyDataModel] = 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.

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.

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.
  2. Tagged endpoints will use the first tag as a module name for the function
  3. 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. 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
  2. Navigate to /tmp/api-docs and generate a single OpenAPI bundle npx @redocly/openapi-cli@latest bundle -o bundle.json
  3. 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 to manage dependencies and packaging. Here are the basics:

  1. Update the metadata in pyproject.toml (e.g. authors, version)
  2. 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:

  1. If that project is using Poetry, you can simply do poetry add <path-to-this-client> from that project
  2. If that project is not using Poetry:
    1. Build a wheel with poetry build -f wheel
    2. Install that wheel from the other project pip install <path-to-wheel>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spacetraders-0.1.1.tar.gz (56.8 kB view details)

Uploaded Source

Built Distribution

spacetraders-0.1.1-py3-none-any.whl (193.8 kB view details)

Uploaded Python 3

File details

Details for the file spacetraders-0.1.1.tar.gz.

File metadata

  • Download URL: spacetraders-0.1.1.tar.gz
  • Upload date:
  • Size: 56.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.8.10 Linux/5.10.102.1-microsoft-standard-WSL2

File hashes

Hashes for spacetraders-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3227e3f6476056bcf18d869e67e3ac49fe6aa11e4d0207388fd2eee4db8fbc04
MD5 71ea0995ce49005c3bd42076a2ffe458
BLAKE2b-256 e412183db24349427e564cc13eeb2ed186fea0cf7ebe07dd9136a350608d132b

See more details on using hashes here.

Provenance

File details

Details for the file spacetraders-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: spacetraders-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 193.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.8.10 Linux/5.10.102.1-microsoft-standard-WSL2

File hashes

Hashes for spacetraders-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cb1962fbd6496d66bea92b8f3e6b0c162f69dbd5fb76b15e1e201ea28b07e200
MD5 172a74a1c792ad3c09264f78b0fc54d7
BLAKE2b-256 02950438a468abcbd23127b23d4faa5fbe9ef012e9aea66bbb6c5434acc28c12

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page