Skip to content

Getting Started

Getting Started


Welcome to the getting started section! This page will help you install ScurryPy, set up your environment, and get ready to build your first bot.

Installation


If you haven't already, you can install ScurryPy with pip:

pip install scurrypy

That's all you need. No extra dependencies.

Setting up


In your main bot file, it’s recommended to load your environment variables and prepare your constants:

import scurrypy, os, dotenv

# Load environment variables (optional but recommended)
dotenv.load_dotenv("path/to/.env")

TOKEN = os.getenv("BOT_TOKEN") # your bot token
APP_ID = ... # your application ID
GUILD_ID = ... # your guild ID (optional, for guild commands)

You’re now ready to start using ScurryPy, either directly or with addons!

Next Steps...


  • Examples - drop-in examples covering events, routing, commands, and more
  • API - detailed class and method documentation
  • Events - all event objects and structures
  • Resources - request helpers for interacting with Discord’s REST API