Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metakgp/gyft
Get Your Freaking Timetable
https://github.com/metakgp/gyft
erp google-calendar gyft hacktoberfest ics timetable
Last synced: 1 day ago
JSON representation
Get Your Freaking Timetable
- Host: GitHub
- URL: https://github.com/metakgp/gyft
- Owner: metakgp
- License: mit
- Created: 2016-08-04T23:09:12.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-07T16:20:45.000Z (14 days ago)
- Last Synced: 2025-01-13T21:07:03.132Z (8 days ago)
- Topics: erp, google-calendar, gyft, hacktoberfest, ics, timetable
- Language: Python
- Homepage: https://gyft.metakgp.org
- Size: 560 KB
- Stars: 58
- Watchers: 15
- Forks: 62
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Wiki][wiki-shield]][wiki-url]
Table of Contents
- [About The Project](#about-the-project)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Development Notes](#development-notes)
- [Updates To Be Made Each Sem](#updates-to-be-made-each-sem)
- [Contributing](#contributing)
- [Maintainer(s)](#maintainers)
## About The Project
Gets your timetable from ERP and adds it to your Google Calendar or gives you an ICS file which you can add in any common calendar application.
> **Note** All updates to this repo should reflect, with appropriate refactorisation, in [gyft-serve](https://github.com/metakgp/gyft-serve/)
## Getting Started
To set up a local instance of the application, follow the steps below.
### Prerequisites
The following prerequisites are required to be installed for the project to function properly:
- Python 3
- IIT-KGP Student [ERP](https://erp.iitkgp.ac.in) Account
### Installation
_Now that the environment has been set up and configured to properly compile and run the project, the next step is to install and configure the project locally on your system._
1. Clone the repository
```sh
git clone --depth 1 https://github.com/metakgp/gyft
```
2. Change the current directory to the project directory
```sh
cd gyft
```
3. Install the dependencies
```sh
pip install -r requirements.txt
```
## Usage
1. Run the script
```sh
python3 gyft.py
```
2. Enter your roll number, password, security answer, and OTP (if required) when prompted
3. Now you can choose between 2 options, which will be prompted to you:
- #### Add to Google Calendar:
- For this, you have to get your `credentials.json` and save it as `client_secret.json` to the current directory by following the Step 1 from [here](https://developers.google.com/google-apps/calendar/quickstart/python#step_1_turn_on_the_api_name)
- Also note that adding to Google Calendar requires an Internet connection
- #### Generate ICS file:
- This will generate an ICS file which you can import into any calendar application.
- For importing to Google Calendar, follow the instructions given [here](https://support.google.com/calendar/answer/37118?hl=en).
- Optional flags:
- To delete all the recurring events added by the CLI or GYFT Web Application (uses a property of recurrence to identify events to delete), you can run `gyft.py` with the `--del-events` flag:
```sh
python3 gyft.py --del-events
```
- To specify the output file (`.ics`) to which the ICS file will be written, use the `--output` flag.
```sh
python3 gyft.py --output autumn_2023.ics
```
## Development Notes
This project utilizes the [iitkgp-erp-login](https://github.com/proffapt/iitkgp-erp-login-pypi/) package to handle ERP login functionality.
### Updates To Be Made Each Sem
The following procedure is to be followed each new semester by the maintainer for updating GYFT to work properly.
- Download the academic calendar for the particular year.
- New semester dates need to be updated in utils/dates.py
- The format for the date-time is `(YYYY, MM, DD, HH, MM)`.
- Raise a pull request once the dates are updated.
## Contributing
Please read [CONTRIBUTING.md](https://github.com/metakgp/gyft/blob/master/CONTRIBUTING.md) guide to know more.
## Maintainer(s)
- [Ashwin Prasanth](https://github.com/ashwinpra)
[contributors-shield]: https://img.shields.io/github/contributors/metakgp/gyft.svg?style=for-the-badge
[contributors-url]: https://github.com/metakgp/gyft/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/metakgp/gyft.svg?style=for-the-badge
[forks-url]: https://github.com/metakgp/gyft/network/members
[stars-shield]: https://img.shields.io/github/stars/metakgp/gyft.svg?style=for-the-badge
[stars-url]: https://github.com/metakgp/gyft/stargazers
[issues-shield]: https://img.shields.io/github/issues/metakgp/gyft.svg?style=for-the-badge
[issues-url]: https://github.com/metakgp/gyft/issues
[license-shield]: https://img.shields.io/github/license/metakgp/gyft.svg?style=for-the-badge
[license-url]: https://github.com/metakgp/gyft/blob/master/LICENSE.txt
[wiki-shield]: https://custom-icon-badges.demolab.com/badge/metakgp_wiki-grey?logo=metakgp_logo&style=for-the-badge
[wiki-url]: https://wiki.metakgp.org