Giter Club home page Giter Club logo

librus-python's Introduction

Librus Client Application

This repository houses the Librus Client Application, a Python tool designed to interact with the Librus Synergia API. It enables users to authenticate and fetch details such as absences, grades, and messages from their Librus accounts.

Features

  • Authentication: Secure login using user credentials stored in environment variables.
  • Data Retrieval: Ability to fetch absences, grades, and inbox messages via CLI.
  • Configurable Logging: Logging setup that can be adjusted via command-line arguments.

Prerequisites

Ensure you have Python 3.11+ and Poetry installed on your machine to handle dependencies and run the project.

Installation

Follow these steps to get your development environment set up:

  1. Clone the Repository:
    git clone https://github.com/yourusername/librus-client.git
    cd librus-client
  2. Install Dependencies: Using Poetry, install the dependencies as follows:
poetry install

Configuration

Set up the necessary environment variables in your system:

LIBRUS_LOGIN: Your Librus Synergia login username.
LIBRUS_PASSWORD: Your Librus Synergia password.

For Unix-based systems, you can set these variables like this:

export LIBRUS_LOGIN='your_login'
export LIBRUS_PASSWORD='your_password'

For Windows systems, use:

set LIBRUS_LOGIN=your_login
set LIBRUS_PASSWORD=your_password

Usage

To run the application, use Poetry to handle the environment:

poetry run python main.py

You can also specify the logging level with the --log argument. Available levels are DEBUG, INFO, WARNING, ERROR, and CRITICAL:

poetry run python main.py --log LEVEL --command COMMAND

Replace LEVEL with your preferred logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL) and COMMAND with one of the supported operations (absences, inbox, message, grades). If querying a specific message, include --message_id ID.

License

This project is licensed under the MIT License - see the LICENSE file for details.

librus-python's People

Contributors

jetalone85 avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.