Skip to main content

mealie-image

Mealie API

If you are running a self-hosted Mealie server you can use this library to authenticate yourself with and intereact with it! Create mealplans, import recipes, remove users, modify user groups, upload recipe images. All with MealieAPI.

Installation

$ pip install mealieapi

Usage

Authentication

To start you need your Mealie server url, and your login credentials or an API key (which you can create at https://[YOUR_MEALIE_SERVER]/admin/profile). MealieAPI uses the async/await syntax so you must run it inside an async function or event loop like so (if you are not familiar with async applications already.)

import asyncio
from mealieapi import MealieClient


client = MealieClient("<YOUR_MEALIE_SERVER_ADDRESS>")

This next part depends on whether you have an API key, or your login credentials.

If you want to use your username and password you must use await client.login("<USERNAME_OR_EMAIL>", "<PASSWORD>") or if you are using an API key you need to use client.authorize("<API_KEY>") (Note: without the await).

async def main():
    await client.login("<USERNAME_OR_EMAIL>", "<PASSWORD>")
    # OR
    client.authorize("<API_KEY>")

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Docs

A work in progress.

Contributions

All contributions are welcome! Thats what makes Open-Source so special.

Metadata

Release files for mealieapi 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mealieapi 0.0.1
File Size Uploaded
mealieapi-0.0.1.tar.gz 23.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mealieapi 0.0.1
File Interpreter ABI Platform
mealieapi-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 49.7 kB

Release files / mealieapi-0.0.1.tar.gz

Download URL mealieapi-0.0.1.tar.gz
Size 23.5 kB
Tags Source
SHA-256 checksum
How to use checksums
92b8ebc216fd018e4e795bee0da93ef6bd82ec9a9ee71d359b69fa378a727d09
BLAKE2b-256 checksum
How to use checksums
b59f617384a5d5a437d3074535b4f0d7255748e89bd72bdbe11a8d6bfa013e6a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.1 CPython/3.11.1 Linux/5.15.0-1024-azure

Release files / mealieapi-0.0.1-py3-none-any.whl

Download URL mealieapi-0.0.1-py3-none-any.whl
Size 26.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
36d12d1917662cd3ba1c09189a3965ee24ca520fae037510c624137389a8eb5b
BLAKE2b-256 checksum
How to use checksums
3ebb792bb610b4656805fa6ae84ef0077493d522330c61e2a87e394749a55c03
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.1 CPython/3.11.1 Linux/5.15.0-1024-azure
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page