Skip to main content

Command-line/Python/Email interface for 'Hallo!Eltern' app for Upper-Austrian schools

Project description

hallo-eltern-cli

Tests

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 their "Hallo!Eltern" application in any way. The "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

You need Python >=3.6

  1. Install the package:

    pip3 install hallo-eltern-cli
    
  2. Set the credentials from your "Hallo!Eltern" application:

    hallo-eltern-cli config --email YOUR-EMAIL@EXAMPLE.ORG --password YOUR-PASSWORD
    
  3. Done \o/

hallo-eltern-cli is now ready for use. For example to list messages, use the list command:

hallo-eltern-cli 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 hallo-eltern4email 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-eltern4email --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.2a0.tar.gz (16.2 kB view details)

Uploaded Source

File details

Details for the file hallo-eltern-cli-0.1.2a0.tar.gz.

File metadata

  • Download URL: hallo-eltern-cli-0.1.2a0.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.2a0.tar.gz
Algorithm Hash digest
SHA256 17a97de11d9cedd803d20bc1c22c1320c8c537ff3fc7cd887d6f8affabcee8c6
MD5 d43ba70732769c814b3055d024236e63
BLAKE2b-256 0d035bc716ae236b2520937bb545f8f249c27acd0c6286cd8a589c0a9ae39553

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