Skip to main content

Python wrapper for the Fatsecret API

Project description

fatsecret

status Documentation Status

This library provides a lightweight python wrapper for the Fatsecret API with the goal of making it easier to visualize the data retrieved from the API. To that end, this library will usually return lists of identical elements for ease of plotting, discarding extra header fields that the Fatsecret API otherwise includes. All API calls return either a single or list of JSON dictionaries.

Installation

pip install fatsecret

Requires Python 3.11+.

Config

Register for a developer account at Fatsecret. You will need your Consumer Key and Consumer Secret key for your application.

Usage

Fatsecret supports both delegated and public calls. Only through delegated calls can you access Fatsecret user profile data.

If you only need public data:

from fatsecret import Fatsecret

fs = Fatsecret(consumer_key, consumer_secret)
foods = fs.foods_search_v5("Tacos")          # current upstream version
# or, to pin to a specific historical shape:
foods = fs.foods_search_v1("Tacos")

Every method carries an explicit _vN version suffix matching FatSecret's multi-version API. Unsuffixed names (foods_search, food_get, …) still exist as DeprecationWarning-emitting aliases and will be removed in v2.0. Surface the warnings during development:

python -W default::DeprecationWarning:fatsecret your_script.py

For OAuth2 client-credentials (required for Premier / Native endpoints):

fs = Fatsecret(client_id, client_secret, auth="oauth2", scopes=["basic", "premier"])

Refer to the documentation for further examples and detail.

Documentation

Docs are published to Read the Docs. Every released tag and the current master branch are auto-built — use the version dropdown in the bottom-left flyout to switch between them.

Contributing

All contributions are welcome! I'm not actively maintaining this library, so there's a good chance that any API changes have not been implemented in this wrapper.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fatsecret-2.4.0.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

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

fatsecret-2.4.0-py3-none-any.whl (34.5 kB view details)

Uploaded Python 3

File details

Details for the file fatsecret-2.4.0.tar.gz.

File metadata

  • Download URL: fatsecret-2.4.0.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for fatsecret-2.4.0.tar.gz
Algorithm Hash digest
SHA256 2d6428ef61b2232c51f57ea1a029bea9bf2ce2ac2df4776c441eab55847678de
MD5 4c8a5d182c78bf235c15992e909ffddd
BLAKE2b-256 2b781fd3d8d4fcf00c61db46c494f31b719e4a9b8398d1a14aff97f069c8ffca

See more details on using hashes here.

File details

Details for the file fatsecret-2.4.0-py3-none-any.whl.

File metadata

  • Download URL: fatsecret-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 34.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for fatsecret-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 414b0c1f9c7a68622a2a8f482ebf206ba5980e0872557d1687889e466e126e54
MD5 b5b74ec160c199cdde01fd00188645b8
BLAKE2b-256 aba573fb228a55f58939f56855498b63a6dfb64466b4a8f6b52260569ac2fbc2

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