This repository has been archived on 2022-08-04. You can view files and clone it, but cannot push or open issues or pull requests.
python-usda/docs/api.rst

1.6 KiB

API Reference

Client

usda.client.UsdaClient

Domain

Base classes

usda.domain.UsdaObject

usda.domain.ListItem

Items

usda.domain.Food

usda.domain.Nutrient

usda.domain.Measure

Food Reports

usda.domain.FoodReport

usda.domain.FoodReportV2

usda.domain.Source

Nutrient Reports

usda.domain.NutrientReportFood

Enums

usda.enums

Low level classes

Base client

usda.base.BASE_URI

usda.base.DataGovClientBase

usda.base.api_request

Exceptions

usda.base.DataGovApiError

usda.base.DataGovApiRateExceededError

usda.base.DataGovInvalidApiKeyError

Pagination

All USDA NDB list API responses are paginated ; to help users not deal with pagination, some specific generators ("paginators") have been created. They are designed to be lazy and will only make requests when necessary.

usda.pagination