Skip to content

Start Here!

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:

1
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:

1
2
3
4
5
6
7
8
9
# --- Environment setup ---
import os
from dotenv import load_dotenv
load_dotenv()

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

Tip

If you use dotenv, you need to install it using:

1
pip install dotenv

Or store it anywhere you like that is not directly in your bot code.

You’re now ready to start using ScurryPy!

Next Steps...

  • Examples - 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