Git Product home page Git Product logo

spielerplus-calendar's Introduction

spielerplus-calendar

Get your Spielerplus events in ICS format for calendar subscription.

CI Build Docker Docker Image)

Setup

  • vscode
  • pyenv
  • python 3.10
  • poetry
  • docker

Tools

  • black
  • pytest
  • pylint
  • mypy

Configuration

The application has to be configured with a config.json file. For an example see tests/data/config.json

  • server: base URL of the Spielerplus server e.g. https://www.spielerplus.de.
  • team[].identity: your personal _identity cookie on the Spielerplus server for the respective team. You can access the cookie value from the the browser settings or DevTools (e.g. Firefox or Chrome). โš ๏ธ Copying from Browser DevTools or pasting into an IDE might mix up the encoding. The value has to be encodet just at the inline double quotes to be a valid json string value. For an example see tests/data/config.json.
  • team[].name: can be chosen freely, as it is only used for naming the calendar.

Development Flask Server

Start a development server:
poetry run flask --app spielerplus_calendar/server.py --debug run

The server is reachable under http://localhost:5000 (flask default).

Endpoints (spielerplus-calendar/server.py):

  • /team/<team_id> serves all Events of the team
  • /personal/<team_id> serves only Events attend

CLI

Generates ICS output for custom postprocessing:
poetry run python spielerplus_calendar/main.py

Production Docker Image

Starts a production ready server in a docker container:
docker run -p 5000:5000 -v $(pwd)/config.json:/app/config.json:ro djbrown/spielerplus-calendar The server will be reachable under port 5000 on all public ip addresses of your machine.

spielerplus-calendar's People

Contributors

djbrown avatar odin568 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.