Skip to main content

Python SDK for the OrbSim API

Project description

OrbSim SDK

Typed Python client for the OrbSim API.

Install

pip install /path/to/orbsim/sdk

Quick Start

from orbsim_sdk import OrbitSource, OrbsimClient, SatelliteCreate, TLEDefinition

client = OrbsimClient("http://127.0.0.1:8000/api")
auth = client.login("admin@example.com", "supersecret123", token_name="SDK Session")
projects = client.list_projects()

satellite = client.create_satellite(
    projects[0].id,
    SatelliteCreate(
        name="ISS Copy",
        source=OrbitSource.TLE,
        tle=TLEDefinition(
            line1="1 25544U 98067A   26099.50000000  .00016717  00000+0  30747-3 0  9991",
            line2="2 25544  51.6400  54.1200 0003870 123.4567 321.6543 15.50000000123456",
        ),
    ),
)

state = client.get_satellite_state(projects[0].id, satellite.id, "2026-04-09T12:00:00Z")
print(state.latitude_deg, state.longitude_deg, state.altitude_m)

Async Quick Start

import asyncio

from orbsim_sdk import AsyncOrbsimClient


async def main():
    async with AsyncOrbsimClient("http://127.0.0.1:8000/api") as client:
        await client.login("admin@example.com", "supersecret123", token_name="Async SDK Session")
        projects = await client.list_projects()
        print([project.name for project in projects])


asyncio.run(main())

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

orbsim_sdk-0.1.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orbsim_sdk-0.1.0-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file orbsim_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: orbsim_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for orbsim_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cf07c5c6e72a4473b9c414b50098d779cf18f566862b12cb7eac4b041a86d2f5
MD5 029589188cdb31dc0daf5f3ddd8c1820
BLAKE2b-256 564fe0fa23d93c41047bb9cccbc2a48f59deacb3a1db2041dd125b49d04a2cc1

See more details on using hashes here.

File details

Details for the file orbsim_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: orbsim_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for orbsim_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6646a916debd86a3bdc39d3f25b417e23863bc62f06ff29cd5484b546cabca15
MD5 a0ce889dea48dab1560ecd0e78116ef0
BLAKE2b-256 fe85dd72e32d6f370088372c0ca0af2c21e52081e54cbaa1d9d6a89ac9ac18ba

See more details on using hashes here.

Supported by

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