{
"info": {
"author": "Tomasz Nie\u017curawski",
"author_email": "tomek.niezurawski@gmail.com",
"bugtrack_url": null,
"classifiers": [
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3"
],
"description": "Dokumentacja w j\u0119zyku polskim jest [tutaj.](README_pl.md)\n# py-librus-api\n# Table of contents\n1. [Intro](#intro)\n2. [Instalation](#instalation)\n3. [Exmaple usage](#example-usage)\n4. [Functions](#functions)\n# Intro\nAPI for librus e-register.
\nThere is no guarantee of developing this API further more!\n# Instalation\nSomeday...\n# Example usage\n```python\nfrom py_librus_api import Librus\n\n\nlibrus = Librus()\n\n\"\"\"Loops until user logs in successfully\"\"\"\nwhile not librus.logged_in:\n if not librus.login(login, password):\n print(\"Log in failed! Check your username and/or password!\")\n else:\n print(\"Logged in successfully!\")\n\n# Your code goes here\n```\nMore info in [functions](#functions)\n# Functions\n**Required params/functions are marked with `!` prefix.**
\n**`*` means that there is explanation below or something is optional.**\n## !login(!login, !password)\nFunction returns `true` if logging in was successful and `false` when not.
\n`login` - Variable that contains user login.
\n`password` - Variable that contains user password.
\nExample usage:\n```python\nlibrus.login(login_var, password_var)\n```\n## You can check if user is logged in!\n```python\nif librus.logged_in:\n ...\n```\n## If user is not logged in, \"User not logged in\" exception will be raised!\n## If connection error occurs, \"Connection error\" will be raised!\n## get_lucky_number()\nReturns lucky number (`int`).\n## get_grades()\n**For displaying grades in the console, it is recommended to use pretty-print (pprint)!**\nReturns all user grades in this foramt:
\n```\ngrades = {\n \"Biologia\": [\n {\n \"Grade\": \"5\",\n \"Weight\": \"3\",\n \"Category\": \"Kartk\u00f3wka\",\n 'Teacher': {'FirstName': 'Jan', 'LastName': 'Kowalski'},\n \"Comment\": \"kartk\u00f3wka z dzia\u0142u o p\u0142azach\",\n \"To_the_average\": \"Tak\"\n }\n ...\n ]\n ...\n}\n```\n**Note that subject names are in language provided by Librus API (in this example it's polish)**\n## get_teachers(mode*)\nReturns teachers' personal data (firstname, lastname) in couple of formats.\nYou can choose format like that:\n```python\nlibrus.get_teachers(mode=\"print\") # etc.\n```\n### List of formats:\n#### normal (default)\n```\n{\n 1123576: {'FirstName': 'Jan', 'LastName': 'Kowalski'},\n 1983456: {'FirstName': 'Gra\u017cyna', 'LastName': 'Kowalska'},\n ...\n}\n```\n#### fullname\n```\n[\n \"Jan Kowalski\",\n \"Gra\u017cyna Kowalska\",\n ...\n]\n```\n#### fullname-id\n```\n[\n '1476937: Jan Kowalski',\n '1484010: Grazyna Kowalska',\n ...\n ]\n```\n## get_school_free_days()\nReturns a list of days free from school.\nFormat:\n```\n[\n {'DateFrom': '2019-01-01', 'DateTo': '2019-01-01', 'Name': 'Nowy Rok'},\n ...\n]\n```\n## get_teacher_free_days()\nReturns a list of teachers' absence.\nFormat:\n```\n[\n {\n 'DateFrom': '2018-10-24',\n 'DateTo': '2018-10-26',\n 'Teacher': {'FirstName': 'Jan', 'LastName': 'Kowalski'},\n 'TimeFrom': '13:40:00',\n 'TimeTo': '15:15:00',\n 'Type': 'szkolenie'\n },\n]\n```\n**It can happen that `TimeFrom` and `TimeTo` won't exist!**\n\n## get_attendances()\nReturns attendances in this format:\n```\n[\n{'AddDate': '2018-10-29 12:52:51',\n 'AddedBy': {'FirstName': 'Jan', 'LastName': 'Kowalski'},\n 'Date': '2018-10-29',\n 'Id': 123456,\n 'Lesson': {'Subject': 'Chemia',\n 'Teacher': {'FirstName': 'Jan', 'LastName': 'Kowalski'}},\n 'LessonNo': 6,\n 'Semester': 1,\n 'Type': {'IsPresenceKind': True,\n 'Name': 'Obecno\u015b\u0107',\n 'Order': 1,\n 'Short': 'ob',\n 'Standard': True}\n }\n ...\n]\n```",
"description_content_type": "text/markdown",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/TheAmazingRak/py-librus-api",
"keywords": "",
"license": "",
"maintainer": "",
"maintainer_email": "",
"name": "py-librus-api",
"package_url": "https://pypi.org/project/py-librus-api/",
"platform": "",
"project_url": "https://pypi.org/project/py-librus-api/",
"project_urls": {
"Homepage": "https://github.com/TheAmazingRak/py-librus-api"
},
"release_url": "https://pypi.org/project/py-librus-api/0.3.1/",
"requires_dist": null,
"requires_python": "",
"summary": "A librus api made in python.",
"version": "0.3.1"
},
"last_serial": 4447848,
"releases": {
"0.2.3": [
{
"comment_text": "",
"digests": {
"md5": "9594c2fc33fc8ad14e52b5ac13460263",
"sha256": "eb7e7819449f2cb79800c16eb897f401893d7f2b43f134760281991958225efd"
},
"downloads": -1,
"filename": "py_librus_api-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "9594c2fc33fc8ad14e52b5ac13460263",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4682,
"upload_time": "2018-11-03T14:41:58",
"url": "https://files.pythonhosted.org/packages/7b/a0/dde2c5d3198562f64c8e08462f994a6c9ba884cb8a0369f51d4f262cce28/py_librus_api-0.2.3.tar.gz"
}
],
"0.2.4": [
{
"comment_text": "",
"digests": {
"md5": "6dbdd8a932e488644d035b2cbef6982b",
"sha256": "e3044bb69e10d8e4959dc09692f6fc8e4a581aa4740192fbbdbf86bafb501866"
},
"downloads": -1,
"filename": "py_librus_api-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "6dbdd8a932e488644d035b2cbef6982b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4684,
"upload_time": "2018-11-03T14:45:32",
"url": "https://files.pythonhosted.org/packages/80/4c/6698a2712dbe7db165e72de108d3a59185465ff90f5520c5319fb95bc87a/py_librus_api-0.2.4.tar.gz"
}
],
"0.2.5": [
{
"comment_text": "",
"digests": {
"md5": "1ed71b1cbae448d17eb56a0afbf04298",
"sha256": "8c7b25ba730754d29788ac69bf5739f912ca0b8ffa994d08474c0c4c94a6acdb"
},
"downloads": -1,
"filename": "py_librus_api-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "1ed71b1cbae448d17eb56a0afbf04298",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4687,
"upload_time": "2018-11-03T14:48:52",
"url": "https://files.pythonhosted.org/packages/83/dd/b912ec143299e6c45c0e07502828a827806eb50b01cd861cb85ecd20c56a/py_librus_api-0.2.5.tar.gz"
}
],
"0.2.6": [
{
"comment_text": "",
"digests": {
"md5": "4cb67017ae22ff37a87e20703339100d",
"sha256": "8f0174b0a65ab0852ade5d15a3c658ecb4108ecff97f505ddb8e6b1918ea134e"
},
"downloads": -1,
"filename": "py_librus_api-0.2.6.tar.gz",
"has_sig": false,
"md5_digest": "4cb67017ae22ff37a87e20703339100d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4703,
"upload_time": "2018-11-03T15:56:36",
"url": "https://files.pythonhosted.org/packages/d5/01/9bb656de94cf06807ddac8e074fe12445676ca88a349bbcba3fe78839601/py_librus_api-0.2.6.tar.gz"
}
],
"0.2.7": [
{
"comment_text": "",
"digests": {
"md5": "d59bda75c08bd8d9b8522a37a5fcc266",
"sha256": "e5f72e8eb79de7c4b9fbf8e263d94a36b319b0e02cca5310ca7cc31a7563ae1e"
},
"downloads": -1,
"filename": "py_librus_api-0.2.7.tar.gz",
"has_sig": false,
"md5_digest": "d59bda75c08bd8d9b8522a37a5fcc266",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4777,
"upload_time": "2018-11-03T17:06:11",
"url": "https://files.pythonhosted.org/packages/98/3e/959bcd6602262646ae9fcc2455138434461f8fe7339e87d85246533a0a9c/py_librus_api-0.2.7.tar.gz"
}
],
"0.3.0": [
{
"comment_text": "",
"digests": {
"md5": "4fc662fc646b4736a841e693baab96bd",
"sha256": "54ee2fa910346d09b8c103d5d66af2086c9c7b80daaf032148b1ac676132afe2"
},
"downloads": -1,
"filename": "py_librus_api-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "4fc662fc646b4736a841e693baab96bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4773,
"upload_time": "2018-11-03T17:12:41",
"url": "https://files.pythonhosted.org/packages/6a/98/b9009ada550bda57dda6c904ef689cf9b452b43354a0795c69fc4cd2c198/py_librus_api-0.3.0.tar.gz"
}
],
"0.3.1": [
{
"comment_text": "",
"digests": {
"md5": "f929f0607348052871ff898565b6b27b",
"sha256": "3dd5db01d25cd1550db1e1e275c7250d010ecb4ffa13a808264e82e92a739f90"
},
"downloads": -1,
"filename": "py_librus_api-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "f929f0607348052871ff898565b6b27b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4793,
"upload_time": "2018-11-03T17:22:31",
"url": "https://files.pythonhosted.org/packages/09/66/1f32cfdc508cddc74cf79461ff5c74c25a518943043212869984ba9d31e9/py_librus_api-0.3.1.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "f929f0607348052871ff898565b6b27b",
"sha256": "3dd5db01d25cd1550db1e1e275c7250d010ecb4ffa13a808264e82e92a739f90"
},
"downloads": -1,
"filename": "py_librus_api-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "f929f0607348052871ff898565b6b27b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4793,
"upload_time": "2018-11-03T17:22:31",
"url": "https://files.pythonhosted.org/packages/09/66/1f32cfdc508cddc74cf79461ff5c74c25a518943043212869984ba9d31e9/py_librus_api-0.3.1.tar.gz"
}
]
}