Skip to main content

wisefood-client

PyPI version Python versions Documentation Status License

A small, robust Python client for accessing and populating the data infrastructure of the WiseFood platform.

The WiseFood platform exposes two distinct APIs, and this package ships one client for each:

  • DataClient — the WiseFood Data API: articles, artifacts, guides, guidelines, textbooks, textbook passages, and food-composition tables (FCTables).
  • Client — the WiseFood API: households, members, and member profiles.

Install

pip install wisefood

Quickstart

import os
from wisefood import DataClient, Credentials

client = DataClient(
    os.environ["WISEFOOD_API_URL"],
    Credentials(username=os.environ["WISEFOOD_USERNAME"],
                password=os.environ["WISEFOOD_PASSWORD"]),
)

article = client.articles["some-article-slug"]
print(article.title)

for hit in client.articles.search("mediterranean diet", limit=5):
    print(hit.title)

Machine-to-machine auth uses client_id / client_secret instead of username/password.

Usage telemetry

The client reports which SDK operations you call, whether they succeeded and how long they took, so platform usage reports account for scripts and notebooks and not only the web app. It never sends your arguments, your results, or anything you passed in.

client.analytics.track("feature.used", app="catalog", feature="bulk-import")
client.feedback.submit(target_type="article", target_id=urn, rating="up",
                       comment="the extraction looks right")
print(client.analytics.session_id)   # groups everything this client did

Turn it off with the environment variable or the constructor:

export WISEFOOD_TELEMETRY=0
client = Client(url, credentials, telemetry=False)

It is queued and sent on a background thread, so it never blocks or raises into your code, and it switches itself off against a deployment whose gateway does not accept it. client.analytics.flush() sends what is queued and keeps going; close() stops it, and runs automatically at exit.

Documentation

Full docs (concepts, per-resource guides, API reference) live at https://wisefood-client.readthedocs.io.

License

See LICENSE.

Release files for wisefood 0.0.31

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

Source distribution (sdist)

Source distribution for wisefood 0.0.31
File Size Uploaded
wisefood-0.0.31.tar.gz 104.7 kB Details

Built distribution (wheel)

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

Total release size: 196.3 kB

Release files / wisefood-0.0.31.tar.gz

Download URL wisefood-0.0.31.tar.gz
Size 104.7 kB
Tags Source
SHA-256 checksum
How to use checksums
d58496d3273e0ab89e726baaa154c272502615cf3f0354c00e953d7809d86409
BLAKE2b-256 checksum
How to use checksums
015e99f01cc39a4577b03f29a97f32f5b4aa5cf7ef0e5fcdde57ff8b71e75257
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.12

Release files / wisefood-0.0.31-py3-none-any.whl

Download URL wisefood-0.0.31-py3-none-any.whl
Size 91.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
20a41332976e9f307674c26589e5701a6eaa94d0fa848256d6c4374e85fd67aa
BLAKE2b-256 checksum
How to use checksums
9d050c0cb8e5b488cd86c17bdb2d7909c59adb17d14e6e70fa0a4dac14b89253
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.12

Release history Release notifications | RSS feed

0.0.42

2 release files

0.0.41

2 release files

0.0.40

2 release files

0.0.37

2 release files

0.0.36

2 release files

0.0.35

2 release files

0.0.34

2 release files

0.0.33

2 release files

0.0.32

2 release files

This release

0.0.31 This release

2 release files

0.0.26

2 release files

0.0.22

2 release files

0.0.21

2 release files

0.0.20

2 release files

0.0.19

2 release files

0.0.18

2 release files

0.0.17

2 release files

0.0.16

2 release files

0.0.15

2 release files

0.0.14

2 release files

0.0.13

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

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