Konzertmeister 3 "G"

erstellt aus einer Anwesenheitsliste verschiedene Formate zum Abhaken der drei "G"s (Getestet, Genesen, Geimpft)

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Problems
5. Example
6. Roadmap
7. Contributing
   • Dependency Management
   • Code quality
8. License
9. Contact

About The Project

konzertmeister-3g ist ein Kommandozeilentool und erstellt aus einer Anwesenheitsliste verschiedene Formate zum Abhaken der drei "G"s (Getestet, Genesen, Geimpft).

Built With

• Typer
• Poetry
• Pyinstaller

Getting Started

Grundvoraussetzung ist eine CSV Datei mit den Anwesenheiten aus Konzertmeister exportiert. In example/export_attendence.html ist der Weg dazu beschrieben.

Prerequisites

Vorausgesetzt wird eine Python Umgebung mit PIP.

Installation

1. Wheel Datei (.whl) aus den Releases herunterladen.
2. konzertmeister-3g installieren

   pip install konzertmeister_3g*.whl

3. Completions installieren (optional)

   konzertmeister-3g --install-completion

Usage

$ konzertmeister-3g [OPTIONS] FILE

Arguments:

• FILE: Konzertmeister CSV [required]

Options:

• -i, --interactively: ask for everything interactively
• --pdf: export PDF
• --xlsx: export XLSX
• --html: export HTML
• --md: export Markdown
• --latex: export LaTeX
• --csv: export CSV
• --checkbox: Checkbox in HTML and Markdown?
• --title TEXT: [default: Nachweiskontrolle 3G (Getestet, Genesen, Geimpft)]
• --date TEXT: [default: aktuelles Datum]
• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show this message and exit.

Problems

Es scheint, als gäbe es Probleme unter Windows (Mac nicht getestet). Auch gibt es bis jetzt nur fertige mit pyinstaller gepackte ausführbare releases.

Example

Hier ein Beispiel, welches auch in example zu finden ist.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Dependency management

Python dependencies are managed via Poetry.

Code quality

Various git pre-commit hooks are in place to ensure code quality:

• Generic formatting and consistency checking.
• Sort Python imports via isort.
• Format Python code via black.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @your_twitter - email@example.com

Project Link: https://github.com/bvrn/konzertmeister-3g