# bakapi-v2
Klient k API Bakalářů v jazyce Python.
Tento projekt je API klient pro Bakaláře, který umožňuje získávat data z API Bakalářů a manipulovat s nimi pomocí jazyka Python. Funkce budou postupně rozšiřovány až do kompletního pokrytí API Bakalářů.
## Licence
Tento projekt obsahuje kód, který je licencován pod MIT licencí. Podrobnosti o této licenci naleznete v souboru `LICENSE` v kořenovém adresáři tohoto repozitáře.
Přispěvatelé k tomuto projektu jsou vyzváni k dodržování podmínek MIT licence pro jakýkoliv kód, který přidají nebo upraví v tomto repozitáři.
Tento projekt používá kód z nasledujícího repozitáře:
[bakapi](https://github.com/mvolfik/bakapi), autor: [mvolfik](https://github.com/mvolfik)
## Instalace
Instalace je možná pomocí `pip` příkazu:
```bash
pip install bakapiv2
py -m pip install bakapiv2
```
## Changelog
### 0.2
- Přidána funkce `get_api_info`, `get_absence`, `get_gdpr_info`, `get_marks`, `get_events`, `get_my_events` a `get_public_events`.
- Nově je možné instalovat balíček pomocí `pip` příkazu.
### 0.1
- První release
## Dokumentace
API klient je navržen pro komunikaci s API Bakalářů pomocí jazyka Python. Poskytuje sadu funkcí pro získávání dat z API a jejich manipulaci.
### Funkce API klienta:
- `get_student_info`: Tato funkce slouží k získání informací o studentovi.
- `get_subjects`: Tato funkce vrátí seznam předmětů a informace o nich..
- `get_timetable_actual`: Tato funkce vrátí rozvrh studenta.
- `get_homework`: Tato funkce vrátí seznam domácích úkolů.
- `get_absence`: Tato funkce vrátí seznam absencí studenta.
- `get_marks`: Tato funkce vrátí seznam známek studenta.
- `get_events`: Tato funkce vrátí seznam událostí.
- `get_my_events`: Tato funkce vrátí seznam událostí studenta.
- `get_public_events`: Tato funkce vrátí seznam veřejných událostí.
- `get_gdpr_info`: Tato funkce vrátí informace o GDPR.
- `get_api_info`: Tato funkce vrátí informace o API.
Pro použití API klienta je nejprve nutné provést inicializaci objektu klienta a přihlášení pomocí přihlašovacích údajů studenta. Poté je možné volat jednotlivé funkce pro získání a manipulaci s daty z API.
Proměnné potřebné pro přihlášení:
- `username`: Uživatelské jméno
- `password`: Heslo
- `url`: URL adresa Bakalářů (musí odkazovat na přihlašovací stránku).
##
Kompletní dokumentaci k API Bakalářů a seznam Endpointů naleznete [zde](https://github.com/bakalari-api/bakalari-api-v3).
Raw data
{
"_id": null,
"home_page": "https://github.com/MortikCZ/bakapi-v2",
"name": "bakapiv2",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Luk\u00e1\u0161 S.",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# bakapi-v2\r\nKlient k API Bakal\u00e1\u0159\u016f v jazyce Python.\r\n\r\nTento projekt je API klient pro Bakal\u00e1\u0159e, kter\u00fd umo\u017e\u0148uje z\u00edsk\u00e1vat data z API Bakal\u00e1\u0159\u016f a manipulovat s nimi pomoc\u00ed jazyka Python. Funkce budou postupn\u011b roz\u0161i\u0159ov\u00e1ny a\u017e do kompletn\u00edho pokryt\u00ed API Bakal\u00e1\u0159\u016f.\r\n\r\n## Licence\r\nTento projekt obsahuje k\u00f3d, kter\u00fd je licencov\u00e1n pod MIT licenc\u00ed. Podrobnosti o t\u00e9to licenci naleznete v souboru `LICENSE` v ko\u0159enov\u00e9m adres\u00e1\u0159i tohoto repozit\u00e1\u0159e. \r\n\r\nP\u0159isp\u011bvatel\u00e9 k tomuto projektu jsou vyzv\u00e1ni k dodr\u017eov\u00e1n\u00ed podm\u00ednek MIT licence pro jak\u00fdkoliv k\u00f3d, kter\u00fd p\u0159idaj\u00ed nebo uprav\u00ed v tomto repozit\u00e1\u0159i.\r\n\r\nTento projekt pou\u017e\u00edv\u00e1 k\u00f3d z nasleduj\u00edc\u00edho repozit\u00e1\u0159e:\r\n[bakapi](https://github.com/mvolfik/bakapi), autor: [mvolfik](https://github.com/mvolfik)\r\n\r\n## Instalace\r\nInstalace je mo\u017en\u00e1 pomoc\u00ed `pip` p\u0159\u00edkazu:\r\n```bash\r\npip install bakapiv2\r\npy -m pip install bakapiv2\r\n```\r\n## Changelog\r\n\r\n### 0.2\r\n- P\u0159id\u00e1na funkce `get_api_info`, `get_absence`, `get_gdpr_info`, `get_marks`, `get_events`, `get_my_events` a `get_public_events`.\r\n- Nov\u011b je mo\u017en\u00e9 instalovat bal\u00ed\u010dek pomoc\u00ed `pip` p\u0159\u00edkazu.\r\n### 0.1\r\n- Prvn\u00ed release \r\n\r\n## Dokumentace\r\nAPI klient je navr\u017een pro komunikaci s API Bakal\u00e1\u0159\u016f pomoc\u00ed jazyka Python. Poskytuje sadu funkc\u00ed pro z\u00edsk\u00e1v\u00e1n\u00ed dat z API a jejich manipulaci.\r\n\r\n### Funkce API klienta:\r\n- `get_student_info`: Tato funkce slou\u017e\u00ed k z\u00edsk\u00e1n\u00ed informac\u00ed o studentovi.\r\n- `get_subjects`: Tato funkce vr\u00e1t\u00ed seznam p\u0159edm\u011bt\u016f a informace o nich..\r\n- `get_timetable_actual`: Tato funkce vr\u00e1t\u00ed rozvrh studenta.\r\n- `get_homework`: Tato funkce vr\u00e1t\u00ed seznam dom\u00e1c\u00edch \u00fakol\u016f.\r\n- `get_absence`: Tato funkce vr\u00e1t\u00ed seznam absenc\u00ed studenta.\r\n- `get_marks`: Tato funkce vr\u00e1t\u00ed seznam zn\u00e1mek studenta.\r\n- `get_events`: Tato funkce vr\u00e1t\u00ed seznam ud\u00e1lost\u00ed.\r\n- `get_my_events`: Tato funkce vr\u00e1t\u00ed seznam ud\u00e1lost\u00ed studenta.\r\n- `get_public_events`: Tato funkce vr\u00e1t\u00ed seznam ve\u0159ejn\u00fdch ud\u00e1lost\u00ed.\r\n- `get_gdpr_info`: Tato funkce vr\u00e1t\u00ed informace o GDPR.\r\n- `get_api_info`: Tato funkce vr\u00e1t\u00ed informace o API.\r\n\r\nPro pou\u017eit\u00ed API klienta je nejprve nutn\u00e9 prov\u00e9st inicializaci objektu klienta a p\u0159ihl\u00e1\u0161en\u00ed pomoc\u00ed p\u0159ihla\u0161ovac\u00edch \u00fadaj\u016f studenta. Pot\u00e9 je mo\u017en\u00e9 volat jednotliv\u00e9 funkce pro z\u00edsk\u00e1n\u00ed a manipulaci s daty z API.\r\n\r\nProm\u011bnn\u00e9 pot\u0159ebn\u00e9 pro p\u0159ihl\u00e1\u0161en\u00ed:\r\n- `username`: U\u017eivatelsk\u00e9 jm\u00e9no\r\n- `password`: Heslo\r\n- `url`: URL adresa Bakal\u00e1\u0159\u016f (mus\u00ed odkazovat na p\u0159ihla\u0161ovac\u00ed str\u00e1nku).\r\n\r\n##\r\nKompletn\u00ed dokumentaci k API Bakal\u00e1\u0159\u016f a seznam Endpoint\u016f naleznete [zde](https://github.com/bakalari-api/bakalari-api-v3).\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Klient k API Bakal\u00e1\u0159\u016f v jazyce Python.",
"version": "0.2",
"project_urls": {
"Documentation": "https://github.com/MortikCZ/bakapi-v2/blob/main/README.md",
"Homepage": "https://github.com/MortikCZ/bakapi-v2",
"Issues": "https://github.com/MortikCZ/bakapi-v2/issues",
"Source Code": "https://github.com/MortikCZ/bakapi-v2/blob/main/bakapi-v2.py"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "81d6e8abf2e734da76589a8685c99687eb6631eb77d2cee37797064024e4c241",
"md5": "4ccc268c4c477703fb2e6202dab3f060",
"sha256": "f07e5ca8a9201a6593f719b94daa6a4cca9391d66d26749773b97ded9c096c5b"
},
"downloads": -1,
"filename": "bakapiv2-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ccc268c4c477703fb2e6202dab3f060",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3186,
"upload_time": "2024-05-07T22:25:39",
"upload_time_iso_8601": "2024-05-07T22:25:39.836779Z",
"url": "https://files.pythonhosted.org/packages/81/d6/e8abf2e734da76589a8685c99687eb6631eb77d2cee37797064024e4c241/bakapiv2-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-07 22:25:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MortikCZ",
"github_project": "bakapi-v2",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bakapiv2"
}
JSON
