Skip to main content

Django App to interface with the AtlantisBot API

Project description

AtlantisBot API (Django App)

This is a Django App made to create an API that interfaces with AtlantisBot's Database.


Setup

  • Install the app

    # Or 'pip install atlantisbot-api'
    poetry add atlantisbot-api
    
  • Add "atlantisbot_api" to your INSTALLED_APPS (in settings.py):

    INSTALLED_APPS = [
        ...
        'atlantisbot_api'
    ]
    
  • (Optional, Discord Oauth) Setup Discord Oauth settings and API keys in your settings.py (sensitive configuration)

    DISCORD_OAUTH2_CLIENT_ID = 'CLIENT_ID'
    DISCORD_OAUTH2_CLIENT_SECRET = 'CLIENT_SECRET'
    DISCORD_OAUTH2_REDIRECT_URI = 'https://your-website-callback-url.com'
    
    DISCORD_API_BASE_URL = 'https://discord.com/api/v6'
    DISCORD_AUTHORIZATION_BASE_URL = DISCORD_API_BASE_URL + '/oauth2/authorize'
    DISCORD_TOKEN_URL = DISCORD_API_BASE_URL + '/oauth2/token'
    if 'http://' in DISCORD_OAUTH2_REDIRECT_URI:
        os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = 'true'
    
  • Include API paths in your project urls.py:

    path('atlantisbot/', include('atlantisbot_api.urls'))
    
  • Run python manage.py migrate to create the atlantisbot models.

  • Your API paths should now be running at the following routes:

    # Database API Routes
    /atlantisbot/api/
    
    # Discord API Oauth routes
    /atlantisbot/api/oauth/user/
    /atlantisbot/api/oauth/authorize/
    

Docs

Management Commands

  • python manage.py clear_secretsanta

    • Clears receiving and giving_to fields on every Secret Santa entry
  • python manage.py roll_secretsanta

    • Make pairs for Secret Santa

Project details


Download files

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

Files for atlantisbot-api, version 1.0.8
Filename, size File type Python version Upload date Hashes
Filename, size atlantisbot_api-1.0.8-py3-none-any.whl (18.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size atlantisbot-api-1.0.8.tar.gz (12.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page