From 9c8c2078638be2c8765a811e5babef07b17ccfae Mon Sep 17 00:00:00 2001 From: Deniz Saner Date: Fri, 16 Aug 2024 12:06:24 +0200 Subject: [PATCH] adapt docs --- docs/api_client/client.rst | 9 ++++++ .../timeseries => api_client}/index.rst | 0 .../production_runs => api_client}/models.rst | 31 +++++++++++++++++-- docs/api_clients/base.rst | 17 ---------- docs/api_clients/index.rst | 9 ------ docs/api_clients/production_runs/client.rst | 9 ------ docs/api_clients/production_runs/index.rst | 8 ----- docs/api_clients/timeseries/client.rst | 11 ------- docs/api_clients/timeseries/models.rst | 30 ------------------ docs/index.rst | 2 +- src/enlyze/api_client/client.py | 1 + src/enlyze/api_client/models.py | 5 ++- 12 files changed, 43 insertions(+), 89 deletions(-) create mode 100644 docs/api_client/client.rst rename docs/{api_clients/timeseries => api_client}/index.rst (100%) rename docs/{api_clients/production_runs => api_client}/models.rst (52%) delete mode 100644 docs/api_clients/base.rst delete mode 100644 docs/api_clients/index.rst delete mode 100644 docs/api_clients/production_runs/client.rst delete mode 100644 docs/api_clients/production_runs/index.rst delete mode 100644 docs/api_clients/timeseries/client.rst delete mode 100644 docs/api_clients/timeseries/models.rst diff --git a/docs/api_client/client.rst b/docs/api_client/client.rst new file mode 100644 index 0000000..d219e2d --- /dev/null +++ b/docs/api_client/client.rst @@ -0,0 +1,9 @@ +Platform API Client +========================== + +.. currentmodule:: enlyze.api_client.client + +.. autoclass:: _PaginatedResponse + +.. autoclass:: PlatformApiClient() + :members: diff --git a/docs/api_clients/timeseries/index.rst b/docs/api_client/index.rst similarity index 100% rename from docs/api_clients/timeseries/index.rst rename to docs/api_client/index.rst diff --git a/docs/api_clients/production_runs/models.rst b/docs/api_client/models.rst similarity index 52% rename from docs/api_clients/production_runs/models.rst rename to docs/api_client/models.rst index 03581d4..1a3048d 100644 --- a/docs/api_clients/production_runs/models.rst +++ b/docs/api_client/models.rst @@ -1,22 +1,47 @@ Models ====== -.. currentmodule:: enlyze.api_clients.production_runs.models +.. currentmodule:: enlyze.api_client.models -.. autoclass:: ProductionRunsApiModel() +.. autoclass:: PlatformApiModel() -.. autoclass:: ProductionRun() +.. autoclass:: Site() + :members: + :undoc-members: + :exclude-members: model_config, model_fields + :show-inheritance: + +.. autoclass:: MachineBase() :members: :undoc-members: :exclude-members: model_config, model_fields :show-inheritance: + .. autoclass:: Machine() :members: :undoc-members: :exclude-members: model_config, model_fields :show-inheritance: +.. autoclass:: Variable() + :members: + :undoc-members: + :exclude-members: model_config, model_fields + :show-inheritance: + +.. autoclass:: TimeseriesData() + :members: + :undoc-members: + :exclude-members: model_config, model_fields + :show-inheritance: + +.. autoclass:: ProductionRun() + :members: + :undoc-members: + :exclude-members: model_config, model_fields + :show-inheritance: + .. autoclass:: Quantity() :members: :undoc-members: diff --git a/docs/api_clients/base.rst b/docs/api_clients/base.rst deleted file mode 100644 index 1f7ef06..0000000 --- a/docs/api_clients/base.rst +++ /dev/null @@ -1,17 +0,0 @@ -Base Client -=========== - -.. currentmodule:: enlyze.api_clients.base - -.. autoclass:: M - -.. autoclass:: R - -.. autoclass:: ApiBaseModel - -.. autoclass:: PaginatedResponseBaseModel - -.. autoclass:: ApiBaseClient - :members: - :private-members: - :undoc-members: diff --git a/docs/api_clients/index.rst b/docs/api_clients/index.rst deleted file mode 100644 index 91ec8e1..0000000 --- a/docs/api_clients/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -API Clients -=========== - -.. toctree:: - :maxdepth: 1 - - base - timeseries/index - production_runs/index diff --git a/docs/api_clients/production_runs/client.rst b/docs/api_clients/production_runs/client.rst deleted file mode 100644 index 2c5f92f..0000000 --- a/docs/api_clients/production_runs/client.rst +++ /dev/null @@ -1,9 +0,0 @@ -Production Runs API Client -========================== - -.. currentmodule:: enlyze.api_clients.production_runs.client - -.. autoclass:: _PaginatedResponse - -.. autoclass:: ProductionRunsApiClient() - :members: diff --git a/docs/api_clients/production_runs/index.rst b/docs/api_clients/production_runs/index.rst deleted file mode 100644 index 34a3568..0000000 --- a/docs/api_clients/production_runs/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Production Runs API -=================== - -.. toctree:: - :maxdepth: 1 - - client - models diff --git a/docs/api_clients/timeseries/client.rst b/docs/api_clients/timeseries/client.rst deleted file mode 100644 index fb84a40..0000000 --- a/docs/api_clients/timeseries/client.rst +++ /dev/null @@ -1,11 +0,0 @@ -Timeseries API Client -===================== - -.. currentmodule:: enlyze.api_clients.timeseries.client - -.. autoclass:: _PaginatedResponse() - :members: - :exclude-members: model_config, model_fields - -.. autoclass:: TimeseriesApiClient() - :members: get, get_paginated diff --git a/docs/api_clients/timeseries/models.rst b/docs/api_clients/timeseries/models.rst deleted file mode 100644 index dd03852..0000000 --- a/docs/api_clients/timeseries/models.rst +++ /dev/null @@ -1,30 +0,0 @@ -Models -====== - -.. currentmodule:: enlyze.api_clients.timeseries.models - -.. autoclass:: TimeseriesApiModel() - -.. autoclass:: Site() - :members: - :undoc-members: - :exclude-members: model_config, model_fields - :show-inheritance: - -.. autoclass:: Machine() - :members: - :undoc-members: - :exclude-members: model_config, model_fields - :show-inheritance: - -.. autoclass:: Variable() - :members: - :undoc-members: - :exclude-members: model_config, model_fields - :show-inheritance: - -.. autoclass:: TimeseriesData() - :members: - :undoc-members: - :exclude-members: model_config, model_fields - :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index 5d9247a..e7e605a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,4 +20,4 @@ User's Guide models errors constants - api_clients/index + api_client/index diff --git a/src/enlyze/api_client/client.py b/src/enlyze/api_client/client.py index e7de931..0fb1ac5 100644 --- a/src/enlyze/api_client/client.py +++ b/src/enlyze/api_client/client.py @@ -111,6 +111,7 @@ def get_paginated( self, api_path: str, model: Type[T], **kwargs: Any ) -> Iterator[T]: """Retrieve objects from paginated ENLYZE Platform API endpoint via HTTP GET + :param api_path: Relative URL path inside the ENLYZE Platform API :param model: Class derived from :class:`~enlyze.api_client.models.PlatformApiModel` diff --git a/src/enlyze/api_client/models.py b/src/enlyze/api_client/models.py index 0c9e685..19381ed 100644 --- a/src/enlyze/api_client/models.py +++ b/src/enlyze/api_client/models.py @@ -33,6 +33,9 @@ def to_user_model(self) -> user_models.Site: class MachineBase(PlatformApiModel): + """The machine related information returned for a + :class:`.ProductionRun`""" + name: str uuid: UUID @@ -159,7 +162,7 @@ def to_user_model(self) -> user_models.Quantity: class ProductionRun(PlatformApiModel): uuid: UUID - machine: MachineBase = Field(alias="appliance") + machine: MachineBase average_throughput: Optional[float] production_order: str product: Product