Skip to main content

Async API wrapper around discordstatus.com

Project description

DiscordStatusPy - async API wrapper around discordstatus

Requirements:

Tested with the stack below. May or may not work on other versions.

  • Python 3.9.6
  • AIOHTTP 3.7.4

Usage:

Example 1:

import asyncio
import DiscordStatusPy

async def main():
    # With suppress_exc we will suppress all raised exceptions and return None
    maintenances = await DiscordStatusPy.get_maintenances(suppress_exc=True)
    print(maintenances['scheduled_maintenances'])

asyncio.run(main())

While you can access the API via the appropriate functions, it's better performance-wise if you use the APIClient class, especially if you're making multiple calls.

Always close connection when you don't need your APIClient instance anymore. For that call its close method:

await my_client.close()

Or use an async content manager which will do that for you:

async with APIClient() as client:
    # Do stuff
# Now it's closed

Example 2:

import asyncio
from DiscordStatusPy import APIClient

async def main():
    # With check_content_type we will check response’s content type
    async with APIClient(check_content_type=True) as client:
        status = await client.get_status()
        incidents = await client.get_incidents()
        print(status['status']['description'])
        print(incidents)

    # Alternatively (less desirable)
    client = APIClient()
    components = await client.get_components()
    print(components)
    await client.close()

asyncio.run(main())

Project details


Download files

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

Source Distribution

DiscordStatusPy-0.0.1.tar.gz (17.1 kB view hashes)

Uploaded Source

Built Distribution

DiscordStatusPy-0.0.1-py3-none-any.whl (17.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page