Skip to main content

Python rewrite of the Eetlijst GraphQL client

Project description

eetlijst-python

A simple Python API client for Eetlijst.

[!NOTE] This project is made for use in a student house, and will probably not be maintained. Most of this Python port was converted from the TypeScript version (https://github.com/DJ1TJOO/eetlijst-api-ts) using Google Gemini.

Usage

Create a virtual environment and install the package:

python -m venv .venv
# Activate virtual environment (.venv\Scripts\Activate.ps1 on Windows or source .venv/bin/activate on Linux/macOS)
python -m pip install -e .

The API key can be retrieved from the account page, under Developer API key (BETA), at https://v5.eetlijst.nl/account

import asyncio
from eetlijst import Eetlijst

eetlijst = Eetlijst("<API_KEY>")

async def main():
    app_status = await eetlijst.app.status()
    print(app_status)

if __name__ == "__main__":
    asyncio.run(main())

See Examples (./examples/) for more.

What is Included

  • Service classes for app, events, expenses, groups, users, groups.users, groups.list, events.attendance, and expenses.settlements.

Development & Codegen

This project uses ariadne-codegen (https://github.com/mirumee/ariadne-codegen) for GraphQL code generation.

Run code generation:

ariadne-codegen

The configuration in pyproject.toml points to the GraphQL schema and outputs generated code into src/generated/.

Building

To build the package locally, install the build tool first:

python -m pip install build

Build the package:

python -m build

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

eetlijst_python-0.0.3.tar.gz (48.2 kB view details)

Uploaded Source

Built Distribution

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

eetlijst_python-0.0.3-py3-none-any.whl (67.5 kB view details)

Uploaded Python 3

File details

Details for the file eetlijst_python-0.0.3.tar.gz.

File metadata

  • Download URL: eetlijst_python-0.0.3.tar.gz
  • Upload date:
  • Size: 48.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for eetlijst_python-0.0.3.tar.gz
Algorithm Hash digest
SHA256 f00ff9c3ae0ca9850cb9eb0cf11f956debe51e622153628a491cafb47169a9b4
MD5 e6bd7cfd876b7ecf194d524875a79d7f
BLAKE2b-256 35827a41655e26af5ddde92d54ca3c31479839b71c073cd8a0477cd1a8c10a24

See more details on using hashes here.

File details

Details for the file eetlijst_python-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for eetlijst_python-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a6bd2b41d6ebb6b1a43c30f0c226329fdefab47efa5ddb63799e0198b01c2fe3
MD5 f5f251e749619d86a0764ac3dd664918
BLAKE2b-256 a13a971edd862d61c49800861211e9c765ee1acff11c5944a25dab0cfd6c7a9a

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