Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
00a0346
constants: add PLATFORM_API_SUB_PATH
denizs Aug 15, 2024
37646d7
fmt: unify ENLYZE platform capitalization
denizs Aug 15, 2024
4fbc308
auth: use Bearer auth scheme
denizs Aug 15, 2024
029bc8c
add api_client package implementing PlatformApiClient scaffold
denizs Aug 15, 2024
664558d
api_client/models: unify api_clients.*.models
denizs Aug 15, 2024
14288fc
models: move from site id to uuid
denizs Aug 15, 2024
4761551
adapt EnlyzeClient to use PlatformApiClient
denizs Aug 16, 2024
867fc26
remove api_clients packages
denizs Aug 16, 2024
62bf4cd
adapt docs
denizs Aug 16, 2024
24a321c
fix datetime before today strategy
denizs Aug 16, 2024
bac7b5a
Merge remote-tracking branch 'origin/master' into major/migrate-to-pl…
denizs Apr 24, 2025
cb0f2ef
update copyright year
denizs Apr 24, 2025
6b08d59
bump test coverage to 100
denizs Apr 24, 2025
8523a4c
run `tox -e docs-fmt`
daniel-k Apr 29, 2025
f27da51
revert unrelated docs formatting
daniel-k Apr 29, 2025
cbad9b3
Update src/enlyze/models.py
denizs Apr 29, 2025
fc0ad66
Update src/enlyze/api_client/client.py
denizs Apr 29, 2025
0418e0e
Update src/enlyze/api_client/client.py
denizs Apr 29, 2025
c2e3d2e
Update src/enlyze/api_client/client.py
denizs Apr 29, 2025
9a145e8
Update src/enlyze/api_client/models.py
denizs Apr 29, 2025
8bd9145
Update src/enlyze/constants.py
denizs Apr 29, 2025
35cf875
don't document private _PaginatedResponse class
denizs Apr 29, 2025
b0aaac4
apply doc string suggestion
denizs Apr 29, 2025
59e49d7
Timeseries API -> API Client
denizs Apr 29, 2025
e87d2e9
remove remaining usage of "timeseries api"
denizs Apr 29, 2025
c2b4f5b
remove comments
denizs Apr 29, 2025
0dd433f
run tox -e docs-fmt
denizs Apr 29, 2025
99a2f4f
refactor production run machine field to reference by uuid
denizs Apr 29, 2025
78a5a31
introduce abstractmethod to_user_model now that MachineBase is gone
denizs Apr 29, 2025
bcba215
add Pydanctic to spelling_wordslist.txt
denizs Apr 29, 2025
d32a2e5
ENLYZE platform API -> ENLYZE platform
denizs May 5, 2025
0c06385
reapply #52
denizs May 5, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2024 ENLYZE GmbH <hello@enlyze.com>
Copyright 2025 ENLYZE GmbH <hello@enlyze.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
Expand Down
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ so:*

$ export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib


Examples
--------------------------------
You can find examples of how to use the Python SDK here: `Notebooks <examples/notebooks>`_
--------

You can find examples of how to use the Python SDK here: `Notebooks
<examples/notebooks>`_
7 changes: 7 additions & 0 deletions docs/api_client/client.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Platform API Client
===================

.. currentmodule:: enlyze.api_client.client

.. autoclass:: PlatformApiClient()
:members:
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Timeseries API
==============
API Client
==========

.. toctree::
:maxdepth: 1
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
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
Expand All @@ -17,6 +17,24 @@ Models
: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:
Expand Down
17 changes: 0 additions & 17 deletions docs/api_clients/base.rst

This file was deleted.

9 changes: 0 additions & 9 deletions docs/api_clients/index.rst

This file was deleted.

9 changes: 0 additions & 9 deletions docs/api_clients/production_runs/client.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api_clients/production_runs/index.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/api_clients/timeseries/client.rst

This file was deleted.

30 changes: 0 additions & 30 deletions docs/api_clients/timeseries/models.rst

This file was deleted.

40 changes: 20 additions & 20 deletions docs/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ a name and an address, which makes it easy to identify for humans.
.. _machine:

Machine
---------
-------

A *machine* refers to a machine that your organization uses to produce goods. For
example, a CNC-milling center, a blown film extrusion line or an injection molding
Expand All @@ -30,8 +30,8 @@ Variable
--------

A *variable* represents a process measure of one :ref:`machine <machine>` of which
timeseries data is captured and stored in the ENLYZE platform. One machine may have
many variables, whereas one variable is only associated with one machine.
timeseries data is captured and stored in the ENLYZE platform. One machine may have many
variables, whereas one variable is only associated with one machine.

.. _production_order:

Expand All @@ -45,38 +45,38 @@ MES and then synchronized into the ENLYZE platform. They are referenced by an id
which oftentimes is a short combination of numbers and/or characters, like FA23000123.

In the ENLYZE platform, a production order always encompasses the production of one
single :ref:`product <product>` on one single :ref:`machine <machine>` within one
or more :ref:`production runs <production_run>`.
single :ref:`product <product>` on one single :ref:`machine <machine>` within one or
more :ref:`production runs <production_run>`.

.. _production_run:

Production Run
--------------

A *production run* is a time frame within which a machine was producing a :ref:`product
<product>` on a :ref:`machine <machine>` in order to complete a :ref:`production
order <production_order>`. A production run always has a beginning and, if it's not
still running, it also has an end.
<product>` on a :ref:`machine <machine>` in order to complete a :ref:`production order
<production_order>`. A production run always has a beginning and, if it's not still
running, it also has an end.

Usually, the operator of the machine uses an interface to log the time when a certain
production order has been worked on. For instance, this could be the machine's HMI or
a tablet computer next to it. In German, this is often referred to as *Betriebsdatenerfassung* (BDE).
It is common, that a production order is not completed in one go, but is interrupted
several times for very different reasons, like a breakdown of the machine or a
public holiday. These interruptions lead to the creation of multiple production runs
for a single production order.
production order has been worked on. For instance, this could be the machine's HMI or a
tablet computer next to it. In German, this is often referred to as
*Betriebsdatenerfassung* (BDE). It is common, that a production order is not completed
in one go, but is interrupted several times for very different reasons, like a breakdown
of the machine or a public holiday. These interruptions lead to the creation of multiple
production runs for a single production order.

.. _product:

Product
-------

A *product* is the output of the production process which is executed by a
:ref:`machine <machine>`, driven by a :ref:`production order <production_order>`. In
the real world, a machine might have some additional outputs, but only the main
output (the product) is modeled in the ENLYZE platform. Similarly to the production order,
a product is referenced by an identifier originating from a customer's system, that gets
synchronized into the ENLYZE platform.
A *product* is the output of the production process which is executed by a :ref:`machine
<machine>`, driven by a :ref:`production order <production_order>`. In the real world, a
machine might have some additional outputs, but only the main output (the product) is
modeled in the ENLYZE platform. Similarly to the production order, a product is
referenced by an identifier originating from a customer's system, that gets synchronized
into the ENLYZE platform.

During the integration into the ENLYZE platform, the product identifier is chosen in
such a way that :ref:`production runs <production_run>` of the same product are
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@


project = "enlyze"
copyright = "2024, ENLYZE GmbH"
copyright = "2025, ENLYZE GmbH"
author = "ENLYZE GmbH"

# -- General configuration ---------------------------------------------------
Expand Down
7 changes: 5 additions & 2 deletions docs/examples.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
Examples
========
In our examples section, you can find Jupyter Notebooks and other material to help you get started:

In our examples section, you can find Jupyter Notebooks and other material to help you
get started:

`Notebooks <https://github.com/enlyze/enlyze-python/tree/master/examples/notebooks>`_:

* `Introduction to the ENLYZE Python SDK <https://github.com/enlyze/enlyze-python/tree/master/examples/notebooks/introduction_enlyze_python_sdk.ipynb>`_
- `Introduction to the ENLYZE Python SDK
<https://github.com/enlyze/enlyze-python/tree/master/examples/notebooks/introduction_enlyze_python_sdk.ipynb>`_
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ User's Guide
models
errors
constants
api_clients/index
api_client/index
1 change: 1 addition & 0 deletions docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ enlyze
entrypoint
iterable
noqa
Pydantic
quickstart
resample
resampled
Expand Down
File renamed without changes.
Loading