Metadata-Version: 2.1
Name: ue-schedule
Version: 1.1.1
Summary: UE Katowice class schedule utility library
Home-page: https://github.com/rimmaciej/ue-schedule
Author: Maciej Rim
Author-email: pypi@mrim.pl
License: UNKNOWN
Description: ## UE Class schedule utility library
        
        A utility library used to download, filter and export class schedule at University of Economics in Katowice.  Imports data from ["Wirtualna uczelnia"](https://e-uczelnia.ue.katowice.pl/).
        
        Each students gets a constant schedule id which is used to generate the schedule.  
        
        You can get your ID by going to "Wirtualna uczelnia" > "Rozkład zajęć" > "Prezentacja harmonogramu zajęć" > "Eksport planu do kalendarza".
        
        The url ends with `/calendarid_XXXXXX.ics`, the XXXXXX will be your ID.
        
        ### Installation
        ```
        pip install ue-schedule
        ```
        
        ### Development
        You can install dependencies in a virtualenv with pipenv
        ```bash
        pipenv install
        
        # for dev dependencies (flake8, pylint, black)
        pipenv install --dev
        
        # switch to the virtualenv
        pipenv shell
        ```
        
        ### Usage
        ```python
        from ue_schedule import Schedule
        
        # initialize the downloader
        s = Schedule(schedule_id)
        
        # get event list
        schedule.get_events()
        
        # get event list as iCalendar
        schedule.get_ical()
        
        # get event list as json
        schedule.get_json()
        ```
        
        Data is automatically fetched when exporting, but you can force fetch with
        ```python
        schedule.fetch()
        ```
        
        If you need to dump the event list and load later
        ```python
        # dump the event list
        events = schedule.dump_events()
        
        # load the event list
        schedule.load_events(events)
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
