API for Vulcan e-journal
Project description
Vulcan API
Description
Python API for Vulcan e-journal system. It's based on the mobile app, so you need to register it as a mobile device on the site.
Installation
You can install vulcan-api
by pip
pip install vulcan-api
Or manually
pip install flit
git clone https://bitbucket.org/kapi2289/vulcan-api.git
cd vulcan-api
flit install
Usage
First, you need to register API as a mobile device on https://uonetplus.vulcan.net.pl/symbol
from vulcan import Vulcan
import json
# Vulcan.create(token, symbol, pin)
cert = Vulcan.create('3S1GFG0P', 'gminaglogow', '059671')
# Save certificate to a file
with open('cert.json') as f:
f.write(json.dumps(cert))
When you have API already registered, you can now use it
from vulcan import Vulcan
import json
# Load certificate from a file
with open('cert.json') as f:
cert = json.loads(f.read())
# Create a client
client = Vulcan(cert)
API automatically selects first pupil, if you have more than one pupil you can get all of them, and set the default
users = client.users()
user = users[0]
client.change_user(user)
For further instructions go to the documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
vulcan-api-0.1.0.tar.gz
(10.9 kB
view hashes)
Built Distribution
vulcan_api-0.1.0-py3-none-any.whl
(11.4 kB
view hashes)
Close
Hashes for vulcan_api-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77791fad6e3c4681f2701619b4aa76bfaacc1132a5f11098ef6648faf89a0b6c |
|
MD5 | 34e739bf304efd595958102a0ede1f6e |
|
BLAKE2b-256 | 19e1fd75faefc59f90d276881c535e1dc319f1101dbaa5773a8a2887e33553fb |