polyapi 5.9.14__tar.gz → 5.9.16__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. {polyapi-5.9.14 → polyapi-5.9.16}/LICENSE.txt +1 -1
  2. polyapi-5.9.16/PKG-INFO +70 -0
  3. polyapi-5.9.16/README.md +39 -0
  4. polyapi-5.9.16/polyapi.egg-info/PKG-INFO +70 -0
  5. {polyapi-5.9.14 → polyapi-5.9.16}/polyapi.egg-info/SOURCES.txt +1 -1
  6. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/business_scenarios.py +398 -110
  7. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/common/consts.py +7 -0
  8. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/common/params_models.py +7 -0
  9. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/error_handler.py +122 -21
  10. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/helper.py +53 -0
  11. {polyapi-5.9.14 → polyapi-5.9.16}/pyproject.toml +4 -4
  12. {polyapi-5.9.14 → polyapi-5.9.16}/setup.py +4 -4
  13. polyapi-5.9.14/PKG-INFO +0 -38
  14. polyapi-5.9.14/README.txt +0 -17
  15. polyapi-5.9.14/polyapi.egg-info/PKG-INFO +0 -38
  16. {polyapi-5.9.14 → polyapi-5.9.16}/polyapi.egg-info/dependency_links.txt +0 -0
  17. {polyapi-5.9.14 → polyapi-5.9.16}/polyapi.egg-info/requires.txt +0 -0
  18. {polyapi-5.9.14 → polyapi-5.9.16}/polyapi.egg-info/top_level.txt +0 -0
  19. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/__init__.py +0 -0
  20. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/authorization.py +0 -0
  21. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/business_logic_doc.py +0 -0
  22. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/commands/__init__.py +0 -0
  23. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/commands/base_command.py +0 -0
  24. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/commands/olap_module.py +0 -0
  25. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/commands/other_modules.py +0 -0
  26. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/common/__init__.py +0 -0
  27. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/common/helper_funcs.py +0 -0
  28. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/exceptions.py +0 -0
  29. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/executor.py +0 -0
  30. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/__init__.py +0 -0
  31. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/base_graph.py +0 -0
  32. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/graph_interface.py +0 -0
  33. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/__init__.py +0 -0
  34. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/areas.py +0 -0
  35. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/balls.py +0 -0
  36. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/chord.py +0 -0
  37. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/circles.py +0 -0
  38. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/circles_series.py +0 -0
  39. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/corridors.py +0 -0
  40. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/cumulative_areas.py +0 -0
  41. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/cumulative_cylinders.py +0 -0
  42. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/cylinders.py +0 -0
  43. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/graph.py +0 -0
  44. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/lines.py +0 -0
  45. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/pies.py +0 -0
  46. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/point.py +0 -0
  47. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/point_series.py +0 -0
  48. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/pools.py +0 -0
  49. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/pools_3d.py +0 -0
  50. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/radar.py +0 -0
  51. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/sankey.py +0 -0
  52. {polyapi-5.9.14 → polyapi-5.9.16}/polymatica/graph/types/surface.py +0 -0
  53. {polyapi-5.9.14 → polyapi-5.9.16}/setup.cfg +0 -0
@@ -1,4 +1,4 @@
1
- Copyright 2020 Polymatica Rus LLC
1
+ Copyright 2020-2025 Polymatica Rus LLC
2
2
 
3
3
  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 without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
4
  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
@@ -0,0 +1,70 @@
1
+ Metadata-Version: 2.4
2
+ Name: polyapi
3
+ Version: 5.9.16
4
+ Summary: Wrapper for Polymatica API
5
+ Home-page: https://slsoft.ru/products/polymatica/
6
+ Author: Polymatica Rus LLC
7
+ Author-email: polymatica_support@slsoft.ru
8
+ License: MIT
9
+ Keywords: polymatica
10
+ Classifier: Development Status :: 5 - Production/Stable
11
+ Classifier: Intended Audience :: End Users/Desktop
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: Programming Language :: Python :: 3
15
+ License-File: LICENSE.txt
16
+ Requires-Dist: setuptools
17
+ Requires-Dist: pandas
18
+ Requires-Dist: requests
19
+ Requires-Dist: pydantic
20
+ Requires-Dist: packaging
21
+ Dynamic: author
22
+ Dynamic: author-email
23
+ Dynamic: classifier
24
+ Dynamic: description
25
+ Dynamic: home-page
26
+ Dynamic: keywords
27
+ Dynamic: license
28
+ Dynamic: license-file
29
+ Dynamic: requires-dist
30
+ Dynamic: summary
31
+
32
+
33
+ # Основные сведения
34
+ Библиотека предназначена для работы с Polymatica API.
35
+
36
+ # Работа с библиотекой
37
+ Основным модулем бизнес-логики является файл business_scenarios.py,
38
+ импортировать который можно с помощью команды ``from polymatica import business_scenarios as sc``.
39
+
40
+ Модуль предоставляет два класса для работы с Полиматикой - ``BusinessLogic`` и ``GetDataChunk``.
41
+ Методы этих классов можно посмотреть при помощи стандартной функции ``dir()``.
42
+
43
+ Аргументы функций и прочую docstring-документацию модуля и функций можно посмотреть
44
+ при помощи стандартной функции ``help()``.
45
+
46
+ ### Инициализация нового клиентского подключения:
47
+ ``session = sc.BusinessLogic(login="your_login", password="your_password", url="polymatica_server_url", **args)``
48
+
49
+ ### Пример создания слоя и воспроизведения сценария на этом слое с использованием PolyAPI
50
+
51
+ Создадим слой:
52
+ ``session.execute_manager_command(command_name="user_layer", state="create_layer")``
53
+
54
+ Запросим список сценариев:
55
+ ``session.execute_manager_command(command_name="scripts", state="get_script_descriptions_list")``
56
+
57
+ Загрузим сценарий на слой, используя полученные на предыдущих шагах идентификаторы слоя и сценария:
58
+ ``session.execute_manager_command(command_name="scripts", state="load_on_layer", runtime_id="d46b7075", script_id="40fc65db", on_load_action=0)``
59
+
60
+ Воспроизведем сценарий:
61
+ ``session.execute_manager_command(command_name="scripts", state="play_to_position", runtime_id="d46b7075", script_id="40fc65db", play_to_position=23, clear_workspace=True)``
62
+
63
+ Получим статус воспроизведения сценария:
64
+ ``session.execute_manager_command(command_name="scripts", state="get_script_status", runtime_id="d46b7075")``
65
+
66
+ Получили ответ, из которого видим, что сценарий воспроизведен успешно:
67
+ ``{'state': 1, 'queries': [{'uuid': '872bdbde-20b9f734-2a5a5ad5-9b08e670', 'command': {'plm_type_code': 227, 'state': 6, 'script_status': {'id': '40fc65db', 'action_name': '', 'status': 3, 'current_step': 24, 'steps_count': 24, 'errors': []}}}]}``
68
+
69
+ Получим информацию о слое:
70
+ ``session.execute_manager_command(command_name="user_layer", state="get_layer", layer_id="d46b7075")``
@@ -0,0 +1,39 @@
1
+
2
+ # Основные сведения
3
+ Библиотека предназначена для работы с Polymatica API.
4
+
5
+ # Работа с библиотекой
6
+ Основным модулем бизнес-логики является файл business_scenarios.py,
7
+ импортировать который можно с помощью команды ``from polymatica import business_scenarios as sc``.
8
+
9
+ Модуль предоставляет два класса для работы с Полиматикой - ``BusinessLogic`` и ``GetDataChunk``.
10
+ Методы этих классов можно посмотреть при помощи стандартной функции ``dir()``.
11
+
12
+ Аргументы функций и прочую docstring-документацию модуля и функций можно посмотреть
13
+ при помощи стандартной функции ``help()``.
14
+
15
+ ### Инициализация нового клиентского подключения:
16
+ ``session = sc.BusinessLogic(login="your_login", password="your_password", url="polymatica_server_url", **args)``
17
+
18
+ ### Пример создания слоя и воспроизведения сценария на этом слое с использованием PolyAPI
19
+
20
+ Создадим слой:
21
+ ``session.execute_manager_command(command_name="user_layer", state="create_layer")``
22
+
23
+ Запросим список сценариев:
24
+ ``session.execute_manager_command(command_name="scripts", state="get_script_descriptions_list")``
25
+
26
+ Загрузим сценарий на слой, используя полученные на предыдущих шагах идентификаторы слоя и сценария:
27
+ ``session.execute_manager_command(command_name="scripts", state="load_on_layer", runtime_id="d46b7075", script_id="40fc65db", on_load_action=0)``
28
+
29
+ Воспроизведем сценарий:
30
+ ``session.execute_manager_command(command_name="scripts", state="play_to_position", runtime_id="d46b7075", script_id="40fc65db", play_to_position=23, clear_workspace=True)``
31
+
32
+ Получим статус воспроизведения сценария:
33
+ ``session.execute_manager_command(command_name="scripts", state="get_script_status", runtime_id="d46b7075")``
34
+
35
+ Получили ответ, из которого видим, что сценарий воспроизведен успешно:
36
+ ``{'state': 1, 'queries': [{'uuid': '872bdbde-20b9f734-2a5a5ad5-9b08e670', 'command': {'plm_type_code': 227, 'state': 6, 'script_status': {'id': '40fc65db', 'action_name': '', 'status': 3, 'current_step': 24, 'steps_count': 24, 'errors': []}}}]}``
37
+
38
+ Получим информацию о слое:
39
+ ``session.execute_manager_command(command_name="user_layer", state="get_layer", layer_id="d46b7075")``
@@ -0,0 +1,70 @@
1
+ Metadata-Version: 2.4
2
+ Name: polyapi
3
+ Version: 5.9.16
4
+ Summary: Wrapper for Polymatica API
5
+ Home-page: https://slsoft.ru/products/polymatica/
6
+ Author: Polymatica Rus LLC
7
+ Author-email: polymatica_support@slsoft.ru
8
+ License: MIT
9
+ Keywords: polymatica
10
+ Classifier: Development Status :: 5 - Production/Stable
11
+ Classifier: Intended Audience :: End Users/Desktop
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: Programming Language :: Python :: 3
15
+ License-File: LICENSE.txt
16
+ Requires-Dist: setuptools
17
+ Requires-Dist: pandas
18
+ Requires-Dist: requests
19
+ Requires-Dist: pydantic
20
+ Requires-Dist: packaging
21
+ Dynamic: author
22
+ Dynamic: author-email
23
+ Dynamic: classifier
24
+ Dynamic: description
25
+ Dynamic: home-page
26
+ Dynamic: keywords
27
+ Dynamic: license
28
+ Dynamic: license-file
29
+ Dynamic: requires-dist
30
+ Dynamic: summary
31
+
32
+
33
+ # Основные сведения
34
+ Библиотека предназначена для работы с Polymatica API.
35
+
36
+ # Работа с библиотекой
37
+ Основным модулем бизнес-логики является файл business_scenarios.py,
38
+ импортировать который можно с помощью команды ``from polymatica import business_scenarios as sc``.
39
+
40
+ Модуль предоставляет два класса для работы с Полиматикой - ``BusinessLogic`` и ``GetDataChunk``.
41
+ Методы этих классов можно посмотреть при помощи стандартной функции ``dir()``.
42
+
43
+ Аргументы функций и прочую docstring-документацию модуля и функций можно посмотреть
44
+ при помощи стандартной функции ``help()``.
45
+
46
+ ### Инициализация нового клиентского подключения:
47
+ ``session = sc.BusinessLogic(login="your_login", password="your_password", url="polymatica_server_url", **args)``
48
+
49
+ ### Пример создания слоя и воспроизведения сценария на этом слое с использованием PolyAPI
50
+
51
+ Создадим слой:
52
+ ``session.execute_manager_command(command_name="user_layer", state="create_layer")``
53
+
54
+ Запросим список сценариев:
55
+ ``session.execute_manager_command(command_name="scripts", state="get_script_descriptions_list")``
56
+
57
+ Загрузим сценарий на слой, используя полученные на предыдущих шагах идентификаторы слоя и сценария:
58
+ ``session.execute_manager_command(command_name="scripts", state="load_on_layer", runtime_id="d46b7075", script_id="40fc65db", on_load_action=0)``
59
+
60
+ Воспроизведем сценарий:
61
+ ``session.execute_manager_command(command_name="scripts", state="play_to_position", runtime_id="d46b7075", script_id="40fc65db", play_to_position=23, clear_workspace=True)``
62
+
63
+ Получим статус воспроизведения сценария:
64
+ ``session.execute_manager_command(command_name="scripts", state="get_script_status", runtime_id="d46b7075")``
65
+
66
+ Получили ответ, из которого видим, что сценарий воспроизведен успешно:
67
+ ``{'state': 1, 'queries': [{'uuid': '872bdbde-20b9f734-2a5a5ad5-9b08e670', 'command': {'plm_type_code': 227, 'state': 6, 'script_status': {'id': '40fc65db', 'action_name': '', 'status': 3, 'current_step': 24, 'steps_count': 24, 'errors': []}}}]}``
68
+
69
+ Получим информацию о слое:
70
+ ``session.execute_manager_command(command_name="user_layer", state="get_layer", layer_id="d46b7075")``
@@ -1,5 +1,5 @@
1
1
  LICENSE.txt
2
- README.txt
2
+ README.md
3
3
  pyproject.toml
4
4
  setup.cfg
5
5
  setup.py