atlantisbot-api

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

Metadata

Release files for atlantisbot-api 1.0.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for atlantisbot-api 1.0.12
File	Size	Uploaded	Provenance
atlantisbot_api-1.0.12.tar.gz	11.5 kB	Aug 16, 2023	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for atlantisbot-api 1.0.12
File	Interpreter	ABI	Platform	Reset
atlantisbot_api-1.0.12-py3-none-any.whl 18.3 kB Aug 16, 2023 Without provenance	Python 3	none	any	Details

Total release size: 29.9 kB

Release files / atlantisbot_api-1.0.12.tar.gz

Download URL	atlantisbot_api-1.0.12.tar.gz
Size	11.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`303ebefca504fdd4b441fd47b0a9cb0bf4338c15ddff6fc13080570e3715164c`
BLAKE2b-256 checksum How to use checksums	`ca411b46db41025d6d4c0913315f3e8c690c6f5c63744530f5c8aeccd59dd88f`
Upload date	Aug 16, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.5.1 CPython/3.11.3 Linux/6.1.39-3-lts`

Release files / atlantisbot_api-1.0.12-py3-none-any.whl

Download URL	atlantisbot_api-1.0.12-py3-none-any.whl
Size	18.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`85b54bd963862d57c8f081d32f45247c53ce9b8cd372807ff36764fd73b20c9c`
BLAKE2b-256 checksum How to use checksums	`f9f53636a9574ebd2d47730508368ce85a502b7e3e8b04a92e7abba9e257702a`
Upload date	Aug 16, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.5.1 CPython/3.11.3 Linux/6.1.39-3-lts`

Security for atlantisbot-api 1.0.12

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.