[!WARNING] Maintenance mode
Pronotepy is currently in maintenance mode. We will continue to fix bugs and adapt to PRONOTE changes, but will not be adding new features. Please do NOT create PRs with new features. They will not get merged.
If you are looking for an alternative that is under active developement, consider using PRONOTE (ex. Pawnote) (JS/TS) or Blocksnote (JS/TS) instead.
pronotepy
An API wrapper for PRONOTE
Explore the docs »
Introduction
Pronotepy is a Python API wrapper for the PRONOTE student administration service. It mainly focuses on student accounts but has limited support for teacher accounts as well. This project does not use the official HYPERPLANNING API provided by PRONOTE, which is inaccessible to students.
About
Dependencies
- pycryptodome
- beautifulsoup4
- requests
- autoslot
Installation
Stable
Install directly from pypi using pip: pip install -U pronotepy
[!NOTE] If you are on Windows and have trouble with this command, use
py -3 -m pip install pronotepy. You must have Python 3 installed on your machine.
Latest
You can install the latest version by installing directly from the repository:
pip install -U git+https://github.com/bain3/pronotepy
We cannot assure that the latest version will be working, but it might have features or bugfixes that are not yet released on pypi.
Testing the package
To self test pronotepy run this command:
python -m pronotepy.test_pronotepy
Please keep in mind that this uses the demo version of pronote and so it can't test every function.
Usage
[!WARNING] The usage part of this readme is for the latest version. If you are installing from pypi, please see the documentation linked at the beginning.
Here is an example script (homework shown in example.py):
import pronotepy
import datetime
from pathlib import Path
import json
# load login from `python3 -m pronotepy.create_login` command.
# See quickstart in documentation for other login methods.
credentials = json.loads(Path("credentials.json").read_text())
client = pronotepy.Client.token_login(**credentials)
if client.logged_in: # check if client successfully logged in
# save new credentials - IMPORTANT
credentials = client.export_credentials()
Path("credentials.json").write_text(json.dumps(credentials))
nom_utilisateur = client.info.name # get users name
print(f'Logged in as {nom_utilisateur}')
# get the all the periods (may return multiple types like trimesters and
# semesters but it doesn't really matter the api will get it anyway)
periods = client.periods
for period in periods:
for grade in period.grades: # iterate over all the grades
print(f'{grade.grade}/{grade.out_of}') # print out the grade in this style: 20/20
For any extra details, please see the documentation linked above.
Contributing
Feel free to contribute anything. Any help is appreciated. To contribute, please create a pull request with your changes.
Setting up the development environment is just cloning the repository and making sure you have all the dependencies by
running pip with the requirements.txt file. Please also install mypy and black for type checking and formatting respectively.
You can find out how mypy is ran in github actions by looking at its configuration file.
If you have any questions about ENTs and their authentification function, please contact Bapt5
Please run these tools before you submit your PR. Thanks!
Adding content
Pronotepy has most of the essential features covered, but if you need anything that is not yet implemented, you can create an issue with your request. (or you can contribute by adding it yourself)
Funding
This repository is on issuehunt. You can put bounties on your issues if you'd like to thank the person who completes it. There is no project account for recieving tips, but you're welcome to tip contributors directly.
License
This project uses the MIT license. (see LICENSE file)
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pronotepy-2.15.7.tar.gz.
File metadata
- Download URL: pronotepy-2.15.7.tar.gz
- Upload date:
- Size: 46.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.10.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e48c47216937897eb4a1e331ca43999f4fa9f8bec0461e1a6c65ffdb0bbc98ec
|
|
| MD5 |
b1a3162af2202857b7eafea755e1f907
|
|
| BLAKE2b-256 |
ca6b4d5d86737a84d52269051b533e7806fd1e1f68b619af7e123c0efbfdd2ff
|
File details
Details for the file pronotepy-2.15.7-py3-none-any.whl.
File metadata
- Download URL: pronotepy-2.15.7-py3-none-any.whl
- Upload date:
- Size: 47.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.10.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
09e040351c034316ee6ba9905d8d7d43c09a032f4f617ba1f01be68fbdfa5812
|
|
| MD5 |
e0f5fe6531659b12b40a2f8359369335
|
|
| BLAKE2b-256 |
5575498381fc5cf24c03c80a62263f53b922994c067a73566d8083bc55544e92
|
