Giter VIP home page Giter VIP logo

azubiheft-api's Introduction

Azubiheft Web API Wrapper

Downloads Downloads Downloads

This library provides a Python wrapper for azubiheft.com. With this library, developers can easily manage their Ausbildung (training) reports through a script, allowing for enhanced automation and better control over their Ausbildung documentation.

๐Ÿ“– About Azubiheft

Azubiheft brings a streamlined online approach to training documentation. Designed for businesses, instructors, and apprentices, it offers an effortless way to manage every training entry online. With Azubiheft, you're always one step ahead with all your training data right at your fingertips.

๐Ÿ›  Installation

pip install azubiheftApi

๐Ÿ” Usage

Here's a quick guide on how to use the azubiheftApi:

from azubiheftApi import azubiheftApi
from datetime import datetime

# Initialize session
azubiheft = azubiheftApi.Session()

# Login
azubiheft.login("yourUserName", "yourPassword")

# Check login status
print(azubiheft.isLoggedIn())

# Get available subjects
subjects = azubiheft.getSubjects()
print(subjects)

# Add a new subject
azubiheft.add_subject("New Subject")

# Delete an existing subject by ID
azubiheft.delete_subject("subjectId")

# Fetch a report by date
report = azubiheft.getReport(datetime(2023, 10, 19))
print(report)


# Get a week's report ID
week_id = azubiheft.getReportWeekId(datetime.now())
print(week_id)

# Write a new report entry
azubiheft.writeReport(datetime(2023, 10, 19), "Hello World", "2:00", 1)
# its also possible to format the text using \n or just like this
# """
# Hello World
# This is a new line
# """

# Fetch the report again to see changes
report = azubiheft.getReport(datetime(2023, 10, 19), include_formatting=True)  #  include_formatting=True to include formatting
print(report)


# delete a report entry
azubiheft.deleteReport(datetime(2023, 10, 19))


# Log out from the session
azubiheft.logout()

# Check login status (should be False after logging out)
print(azubiheft.isLoggedIn())

๐ŸŒฑ Contribution

Feel free to fork, star, or contribute to this repository. For any bugs or feature requests, please open a new issue.


azubiheft-api's People

Contributors

leonkohli avatar jjoshm avatar coderxxl avatar

Stargazers

 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.