Skip to main content

spectrum.py is a [discord.py](https://github.com/Rapptz/discord.py) style proof-of-concept library for making chatbots for Star Citizen's [Spectrum](https://robertsspaceindustries.com/spectrum/community/SC) chat client.

Project description

spectrum.py

spectrum.py is a discord.py style proof-of-concept library for making chatbots for Star Citizen's Spectrum chat client. It also offers HTTP clients for interacting with both Spectrum's REST API and the Community Hub's GraphQL API.

Installation

# Latest Release
python -m pip install spectrum.py
# Latest in Github
python -m pip install git+https://github.com/henry232323/spectrum.py

Examples

With Gateway

import asyncio
from spectrum import Client, Message

class MyClient(Client):
    async def on_message(self, message: Message):
        print(message)

    async def on_ready(self):
        print("We're ready!")


async def run():
    myclient = MyClient(
        rsi_token=...,
        device_id=...,
    )

    asyncio.ensure_future(myclient.run())
    await asyncio.Event().wait()


asyncio.run(run())

HTTP Only

import asyncio
from spectrum import HTTPClient

async def run():
    client = HTTPClient(
        rsi_token=...,
        device_id=...,
    )

    await client.identify()
    member = await client.fetch_member_by_handle("Khuzdul")
    print(member)

    await client.close()

asyncio.run(run())

Community Hub

import asyncio
from spectrum import CommunityHubClient

async def run():
    client = CommunityHubClient()
    print(await client.fetch_user_profile("Khuzdul"))

asyncio.run(run())

Authentication

The bot can be run in a read only state without any authentication. If you want to be able to send messages or read private messages (and eventually do other things), you'll need to provide credentials for an RSI account. These can be found in the cookies sent with any request to RSI when logged in.

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

spectrum.py-0.0.7.tar.gz (26.5 kB view details)

Uploaded Source

Built Distribution

spectrum.py-0.0.7-py3-none-any.whl (36.3 kB view details)

Uploaded Python 3

File details

Details for the file spectrum.py-0.0.7.tar.gz.

File metadata

  • Download URL: spectrum.py-0.0.7.tar.gz
  • Upload date:
  • Size: 26.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for spectrum.py-0.0.7.tar.gz
Algorithm Hash digest
SHA256 f360640d3713ab0a0b9dfc98ece15cb19f95a32c9c51eef07ce0aa93d76e6c27
MD5 aa6b432967cfacde9c88a5eef88db3ec
BLAKE2b-256 93c035e716b6f6cbee75c7b55bbc2b41c81a72e86b84025efeb6f8248e9fce1f

See more details on using hashes here.

File details

Details for the file spectrum.py-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: spectrum.py-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 36.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for spectrum.py-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 aed3f62d9ffc46791cfc6e08fec08578c2956931c5bed2f2e1ec32235331f753
MD5 a4c9e2998e191ba841a485a7d74a60df
BLAKE2b-256 14e08cedab97498a755e9e2bfc8d740d513bac38464bb6ce5ed62fd567c86873

See more details on using hashes here.

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