Skip to main content

A Python API for accessing USDA FoodData Central data

Project description

FoodData Central Python API

This package provides a simple, ready-to-use Python API for accessing and querying relevant data from the USDA FoodData Central database—no API key required. All data is processed locally from CSV files and exposed through a clean Python interface.

Installation

You can install the package from PyPI:

pip install pyfooda

Or install directly from the repository:

pip install git+https://github.com/yourusername/pyfooda.git

Features

  • No API key required: Works entirely offline with preprocessed FoodData Central CSV files.
  • Simple: Query food categories, nutrients, and portion information with a few lines of code.
  • Search: Find foods by partial name.
  • DataFrames: Access the raw fooddata and DRV DataFrames for custom analysis.

Example

import pyfooda as pf

# Find up to 10 foods matching a partial name
print(pf.find_closest_matches('apple'))

# Get the category of a food
print(pf.get_category('Apple, raw'))

# Get all nutrient values for a food
nutrients = pf.get_nutrients('Apple, raw')
print(nutrients)

# Get portion information
print(pf.get_portion_gram_weight('Apple, raw'))  # e.g., 138.0
print(pf.get_portion_unit_name('Apple, raw'))    # e.g., "medium"

# Get the raw DataFrames
fooddata_df = pf.get_fooddata_df()
drv_df = pf.get_drv_df()

API Reference

get_category(foodName)

Returns the food category for the given food name (case-insensitive). Returns 'Other' if not found.

get_nutrients(foodName)

Returns a dictionary of nutrient values for the given food name. Returns None if not found.

get_portion_gram_weight(foodName)

Returns the portion gram weight (float) for the given food name. Returns None if not found.

get_portion_unit_name(foodName)

Returns the portion unit name (string) for the given food name. Returns None if not found.

find_closest_matches(partialName)

Returns a list of up to 10 food names that contain the given partial name (case-insensitive).

get_fooddata_df()

Returns the fooddata DataFrame containing all food items and their nutrient values.

get_drv_df()

Returns the DRV (Dietary Reference Values) DataFrame containing nutrient reference values.

License

Test package

pip install -e .
python -c "import pyfooda; print(pyfooda.__version__)"

MIT License

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

pyfooda-0.1.5.tar.gz (9.0 MB view details)

Uploaded Source

Built Distribution

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

pyfooda-0.1.5-py3-none-any.whl (9.3 MB view details)

Uploaded Python 3

File details

Details for the file pyfooda-0.1.5.tar.gz.

File metadata

  • Download URL: pyfooda-0.1.5.tar.gz
  • Upload date:
  • Size: 9.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for pyfooda-0.1.5.tar.gz
Algorithm Hash digest
SHA256 56f65315518e4541856aacf8a2b9fed60e8e7b201cca13cff4fc5554c90d67f4
MD5 37f4c17b3ffeec578f54ed54d2fd8e05
BLAKE2b-256 7763afd3b8c622ab2946c2da572ccae73cd8f4d8acfcb3d0731853f47f7fc637

See more details on using hashes here.

File details

Details for the file pyfooda-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: pyfooda-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 9.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for pyfooda-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6fc16de383acc7a0783988a65eccee5223dd65dabca8a6127dd3203b36044328
MD5 150903c8b9dcb6c4ddd1d2fec5cb02c6
BLAKE2b-256 3c5780364af935e55d26d8984a6c0ac5e2b01acebcbe7f6f2ace0281ed479922

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