2018-10-26 06:28:44 +00:00
|
|
|
API Reference
|
|
|
|
|
=============
|
|
|
|
|
|
2018-10-26 14:04:52 +00:00
|
|
|
.. contents::
|
2018-10-26 17:40:23 +00:00
|
|
|
:local:
|
|
|
|
|
:backlinks: none
|
2018-10-26 14:04:52 +00:00
|
|
|
|
2018-10-26 06:28:44 +00:00
|
|
|
Client
|
|
|
|
|
------
|
|
|
|
|
|
2018-10-26 14:04:52 +00:00
|
|
|
.. autoclass:: usda.client.UsdaClient
|
2018-10-26 06:28:44 +00:00
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
Domain
|
|
|
|
|
------
|
|
|
|
|
|
2018-10-26 14:04:52 +00:00
|
|
|
Base classes
|
|
|
|
|
^^^^^^^^^^^^
|
|
|
|
|
|
2019-10-23 18:14:44 +00:00
|
|
|
.. autoclass:: usda.domain.UsdaObject
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: usda.domain.ListItem
|
|
|
|
|
:members:
|
2018-10-26 14:04:52 +00:00
|
|
|
|
|
|
|
|
Items
|
|
|
|
|
^^^^^
|
|
|
|
|
|
2019-10-23 18:14:44 +00:00
|
|
|
.. autoclass:: usda.domain.Food
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: usda.domain.Nutrient
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: usda.domain.Measure
|
|
|
|
|
:members:
|
2018-10-26 14:04:52 +00:00
|
|
|
|
|
|
|
|
Food Reports
|
|
|
|
|
^^^^^^^^^^^^
|
|
|
|
|
|
2019-10-23 18:14:44 +00:00
|
|
|
.. autoclass:: usda.domain.FoodReport
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: usda.domain.FoodReportV2
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: usda.domain.Source
|
|
|
|
|
:members:
|
2018-10-26 14:04:52 +00:00
|
|
|
|
|
|
|
|
Nutrient Reports
|
|
|
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
|
|
2019-10-23 18:14:44 +00:00
|
|
|
.. autoclass:: usda.domain.NutrientReportFood
|
|
|
|
|
:members:
|
2018-10-26 06:28:44 +00:00
|
|
|
|
|
|
|
|
Enums
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
.. automodule:: usda.enums
|
2019-10-23 18:14:44 +00:00
|
|
|
:members: UsdaUriActions, UsdaNdbListType, UsdaNdbReportType,
|
|
|
|
|
UsdaNdbDataSource
|
2018-10-26 06:28:44 +00:00
|
|
|
|
|
|
|
|
Low level classes
|
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
|
|
Base client
|
|
|
|
|
^^^^^^^^^^^
|
|
|
|
|
|
2019-10-23 18:14:44 +00:00
|
|
|
.. autodata:: usda.base.BASE_URI
|
|
|
|
|
|
|
|
|
|
.. autoclass:: usda.base.DataGovClientBase
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autofunction:: usda.base.api_request
|
2018-10-26 14:04:52 +00:00
|
|
|
|
|
|
|
|
Exceptions
|
|
|
|
|
^^^^^^^^^^
|
|
|
|
|
|
2019-10-23 18:14:44 +00:00
|
|
|
.. autoexception:: usda.base.DataGovApiError
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoexception:: usda.base.DataGovApiRateExceededError
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoexception:: usda.base.DataGovInvalidApiKeyError
|
|
|
|
|
:members:
|
2018-10-26 06:28:44 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
.. automodule:: usda.pagination
|
2018-10-26 14:04:52 +00:00
|
|
|
:members: RawPaginator, ModelPaginator, RawNutrientReportPaginator
|
