Skip to content

hs3city/glider

Repository files navigation

Glider

Requirements

Installation

1. Clone the Repository

git clone https://github.com/hs3city/glider
cd glider

2. Create a Virtual Environment

python -m venv venv
source venv/bin/activate

3. Install Dependencies

Using poetry

poetry install

4. Set Up Environment Variables

Create a .env file or export these variables:

export DISCORD_TOKEN='your-discord-bot-token'
export SPACE_ENDPOINT='https://your-space-api-endpoint.com/'
export DISCORD_CHANNEL_ID='your-discord-channel-id'

5. Run the Bot

python bot.py

Or with poetry:

poetry run python bot.py

Docker Deployment

A Dockerfile is included for containerized deployment.

Build the Docker Image

docker build -t glider .

Run the Container

docker run -e DISCORD_TOKEN='discord-bot-token' \
           -e SPACE_ENDPOINT='https://your-space-api-endpoint.com/' \
           -e DISCORD_CHANNEL_ID='your-discord-channel-id' \
           glider

Configuration

  • res/glider_closed.png & res/glider_open.png: Bot avatars for different statuses.
  • poetry.lock: Python dependencies.
  • ruff.toml: Linter configuration.

Contributing

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Submit a pull request.

License

This project is licensed under the terms of the MIT.

About

Discord bot that reflects the status of your Space

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors 6