Skip to main content

A command-line/Python/email interface for Education Group GmbH's 'Hallo!Eltern' App for Upper-Austrian schools.

Project description

hallo-eltern-cli

hallo-eltern-cli is a command-line/Python/email interface for Education Group GmbH's "Hallo!Eltern" application for Upper-Austrian schools.

hallo-eltern-cli is not affiliated with Education Group GmbH or the "Hallo!Eltern" Application in any way. "Hallo!Eltern" Application is a product of the Education Group GmbH.

hallo-eltern-cli allows to list, messages, read them, download attachments, etc directly from your Linux terminal and allows to get full messages including attachments directly to your local inbox.

Table of Contents

  1. Installation
  2. CLI Commands
  3. Email Integration

Installation

On a Linux-like system with a recent Python (>=3.7) run:

# Install Python's "requests" library:
sudo apt-get install python3-requests

# Clone this repo:
git clone https://github.com/somechris/hallo-eltern-cli

# Switch to the cloned repo:
cd hallo-eltern-cli

# Configure your credentials:
./halloelterncli.py config --email YOUR-EMAIL@EXAMPLE.ORG --password YOUR-PASSWORD

# Done. \o/

# You can now use the hallo-eltern-cli
# E.g.: List your messages:
./halloelterncli.py list
[...]

Flags |   Id    | Subject
---------------------------------------------------
 CC   | 1234567 | Wandertag am Donnerstag
 CC   | 3456789 | Schikurs Anmeldung
  C   | 2345678 | Fehlendes Arbeitsblatt

CLI commands

The CLI offers the following commands:

  • list lists available messages
  • show shows a message
  • open marks a message as open
  • close marks a message as closed
  • config updates and dumps the configuration
  • test tests the configured user againts the API

Email integration

hallo-eltern-cli comes with halloeltern4email.py which allows to format messages as emails (containing the full message's text and attachments) and submit them to a mail delivery agent (MDA, e.g. procmail). To run it for example 12 minutes into every hour, simply add a crontab entry like:

12 * * * * /path/to/hallo-eltern-cli/halloeltern4email.py --mode=procmail

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hallo-eltern-cli-0.1.0.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hallo_eltern_cli-0.1.0-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file hallo-eltern-cli-0.1.0.tar.gz.

File metadata

  • Download URL: hallo-eltern-cli-0.1.0.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.15 CPython/3.6.9 Linux/5.4.0-125-generic

File hashes

Hashes for hallo-eltern-cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 756ceef8440de84d77a787ee394fffd91446ac4e8959ad608bf773e64fd677fd
MD5 4f6387d2ff78b2c8753dce2155989f05
BLAKE2b-256 7c46a214bba1edfad30189521ba9df72ea6981942c65a15dcf61c0353723f6ed

See more details on using hashes here.

File details

Details for the file hallo_eltern_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: hallo_eltern_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.15 CPython/3.6.9 Linux/5.4.0-125-generic

File hashes

Hashes for hallo_eltern_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 714e6ab2eb15419a1c0401584c983774e5b801b2ed9cb71f3a8d48b489727689
MD5 6ce0782a793f2c0c85240e6dae932b0c
BLAKE2b-256 ba960c656c4da08aa31f84cc252ede54e572b2a8c32d3c8188e49db11d81c075

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page