Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.26 KB

README.md

File metadata and controls

43 lines (32 loc) · 1.26 KB

aiocvv

An API wrapper for Classeviva written in Python using asyncio.

It's made to be easy to use, and handles rate-limits and caching (using shelve) as the API has very strict rate-limits.

Teachers' endpoints haven't been implemented yet. If you are a teacher and/or you want to contribute, feel free to open a pull request.

Installation

pip install -U aiocvv

Example usage

import asyncio
from aiocvv import ClassevivaClient

async def main():
    client = ClassevivaClient("username", "password")
    await client.login() # IMPORTANT! Without this, client.me will be None
    print(client.me.name)

if __name__ == "__main__":
    asyncio.run(main())

You can also await the client class, so it will automatically login for you.

import asyncio
from aiocvv import ClassevivaClient

async def main():
    client = await ClassevivaClient("username", "password")
    print(client.me.name)

if __name__ == "__main__":
    asyncio.run(main())

A more complex example showing most of what this library can do can be found here.

Documentation

The documentation can be found here.