PyPI - Version GitHub Actions Workflow Status

CSP.py

Native Python, async-friendly implementation of Cubesat Space Protocol.

Features

  • Python friendly async API
  • Sockets and connections
  • Interfaces
  • Socket options
  • CIDR Routing table
  • Hooks for inspecting and/or modifying packets going through node
  • System services
    • Ping

Missing features compared to libcsp

  • RDP
  • Packet flags
    • HMAC
  • Remaining system sevices: uptime, reboot/shutdown, process list, memory free query, CSP Management Protocol
  • Simple fragmentation protocol

When to use over libcsp?

  • Easy use (pure Python library, no native dependencies)
  • Testing
    • csp-py allows to start and tear down entire node within single test without leaking anything between tests
  • Async API
    • Use asyncio to run communication, with gracefully handled timeouts and cancellations

Usage

  1. Install package using pip 
    user$ pip install cubesat-space-protocol-py
  2. Create node: 
    import csp_py

node = csp_py.CspNode()
  3. Add interface 
    from csp_py.interfaces.serializing_interface import CspSerializingInterface

async def capture_frame(frame: bytes) -> None:
    # TODO: frame contains entire serialized packet including header
    # send it over some communication channel
    pass

async def handle_incoming_frames(iface: CspSerializingInterface) -> None:
    while True:
        # TODO: fetch frame from communication channel
        frame: bytes = await recv_frame()
        await iface.on_incoming_frame(frame)

iface = CspSerializingInterface(capture_frame)
# TODO: make sure addresses are correct
node.router.add_interface(iface, address=1, netmask_bits=10)
asyncio.create_task(handle_incoming_frames(iface))
  4. Start router task 
    router_task = asyncio.create_task(node.router.arun())
  5. Use sockets 
    connection = await node.connect(dst=0, port=20)
await connection.send(b'Hello, world!')
response = await connection.recv()
print(f'Got response: {response.data}')
  6. Stop router 
    router_task.cancel()
await router_task

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for Novakov from gravatar.com Novakov

Credits

Author: KP Labs

License expression

MIT
View SPDX License List

Requires

Python >=3.12

Classifiers

Report project as malware

Download files

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

Source Distribution

cubesat_space_protocol_py-1.5.0.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

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

cubesat_space_protocol_py-1.5.0-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file cubesat_space_protocol_py-1.5.0.tar.gz.

File metadata

File hashes

Hashes for cubesat_space_protocol_py-1.5.0.tar.gz
Algorithm Hash digest
SHA256 82a79297e599ed9f175e793d1b355d6da001451aa7acd98a323013d9e9ab43d9
MD5 5fe7aefecdb9599fddb1226959bfc587
BLAKE2b-256 83b4241b2e3b7f7e128dcef18aebcfaddafc26547cdc6b66b4190fd72343acfd

See more details on using hashes here.

Provenance

The following attestation bundles were made for cubesat_space_protocol_py-1.5.0.tar.gz:

Publisher: publish.yml on kplabs-pl/csp-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cubesat_space_protocol_py-1.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cubesat_space_protocol_py-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8a52ed0f0322438ebd6c8b34b26cba7fd53cdbae94c8f26893fec88656043ee2
MD5 de1ee7cdee613a54736b28d30fa9a2e9
BLAKE2b-256 2cc649792c8b215243121158daad60f65578a66195ba71fb8116ff24b0ae84f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for cubesat_space_protocol_py-1.5.0-py3-none-any.whl:

Publisher: publish.yml on kplabs-pl/csp-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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