ansys-api-workbench 0.2.0__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.
@@ -0,0 +1,12 @@
1
+ # This is the list of ansys-api-workbench significant contributors.
2
+ #
3
+ # This file does not necessarily list everyone who has contributed code.
4
+ #
5
+ # For contributions made under a Corporate CLA, the organization is
6
+ # added to this file.
7
+ #
8
+ # If you have contributed to the repository and wish to be added to this file
9
+ # please submit a request.
10
+ #
11
+ #
12
+ ANSYS, Inc.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
6
+ this software and associated documentation files (the "Software"), to deal in
7
+ the Software without restriction, including without limitation the rights to
8
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9
+ of the Software, and to permit persons to whom the Software is furnished to do
10
+ so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,72 @@
1
+ Metadata-Version: 2.1
2
+ Name: ansys-api-workbench
3
+ Version: 0.2.0
4
+ Summary: Autogenerated python gRPC interface package for ansys-api-workbench, built on 15:27:28 on 12 June 2024
5
+ Home-page: https://github.com/ansys-internal/ansys-api-workbench
6
+ Author: ANSYS, Inc.
7
+ Author-email: pyansys.core@ansys.com
8
+ License: MIT
9
+ Project-URL: Source, https://github.com/ansys/ansys-api-workbench/
10
+ Project-URL: Tracker, https://github.com/ansys/ansys-api-workbench/issues/
11
+ Project-URL: Documentation, https://github.com/ansys/ansys-api-workbench/#readme
12
+ Requires-Python: >=3.7
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ License-File: AUTHORS
16
+ Requires-Dist: grpcio~=1.47
17
+ Requires-Dist: protobuf<6,>=3.19
18
+
19
+ ### ansys-api-workbench gRPC Interface Package
20
+
21
+ This Python package contains the auto-generated gRPC Python interface files for
22
+ the Ansys Workbench Service.
23
+
24
+
25
+ #### Installation
26
+
27
+ Provided that these wheels have been published to public PyPI, they can be
28
+ installed with:
29
+
30
+ ```
31
+ python -m pip install ansys-api-workbench
32
+
33
+ ```
34
+
35
+ #### Build
36
+
37
+ To build the gRPC packages, run:
38
+
39
+ ```
40
+ python -m pip install build
41
+ python -m build
42
+ ```
43
+
44
+ This will create both the source distribution containing just the protofiles
45
+ along with the wheel containing the protofiles and build Python interface
46
+ files.
47
+
48
+ #### Manual deployment
49
+
50
+ After building the packages, manually deploy them with:
51
+
52
+ ```
53
+ python -m pip install twine
54
+ python -m twine upload dist/*
55
+ ```
56
+
57
+ Note that this is automatically done through CI/CD.
58
+
59
+ #### Automatic deployment
60
+
61
+ This repository contains GitHub CI/CD that enables the automatic building of
62
+ source and wheel packages for these gRPC Python interface files. By default,
63
+ these are built on PRs, the main branch, and on tags when pushing. Artifacts
64
+ are uploaded for each PR.
65
+
66
+ To publicly release wheels to PyPI, ensure your branch is up-to-date and then
67
+ push tags. For example, for the version ``v0.5.0``.
68
+
69
+ ```bash
70
+ git tag v0.5.0
71
+ git push --tags
72
+ ```
@@ -0,0 +1,54 @@
1
+ ### ansys-api-workbench gRPC Interface Package
2
+
3
+ This Python package contains the auto-generated gRPC Python interface files for
4
+ the Ansys Workbench Service.
5
+
6
+
7
+ #### Installation
8
+
9
+ Provided that these wheels have been published to public PyPI, they can be
10
+ installed with:
11
+
12
+ ```
13
+ python -m pip install ansys-api-workbench
14
+
15
+ ```
16
+
17
+ #### Build
18
+
19
+ To build the gRPC packages, run:
20
+
21
+ ```
22
+ python -m pip install build
23
+ python -m build
24
+ ```
25
+
26
+ This will create both the source distribution containing just the protofiles
27
+ along with the wheel containing the protofiles and build Python interface
28
+ files.
29
+
30
+ #### Manual deployment
31
+
32
+ After building the packages, manually deploy them with:
33
+
34
+ ```
35
+ python -m pip install twine
36
+ python -m twine upload dist/*
37
+ ```
38
+
39
+ Note that this is automatically done through CI/CD.
40
+
41
+ #### Automatic deployment
42
+
43
+ This repository contains GitHub CI/CD that enables the automatic building of
44
+ source and wheel packages for these gRPC Python interface files. By default,
45
+ these are built on PRs, the main branch, and on tags when pushing. Artifacts
46
+ are uploaded for each PR.
47
+
48
+ To publicly release wheels to PyPI, ensure your branch is up-to-date and then
49
+ push tags. For example, for the version ``v0.5.0``.
50
+
51
+ ```bash
52
+ git tag v0.5.0
53
+ git push --tags
54
+ ```
@@ -0,0 +1,3 @@
1
+ [build-system]
2
+ requires = ["setuptools >= 42.0.0", "wheel", "ansys_tools_protoc_helper"]
3
+ build-backend = "setuptools.build_meta:__legacy__"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,77 @@
1
+ # Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
2
+ # SPDX-License-Identifier: MIT
3
+ #
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
23
+ """Installation file for the ansys-api-workbench package"""
24
+
25
+ import os
26
+ from datetime import datetime
27
+
28
+ import setuptools
29
+
30
+ from ansys.tools.protoc_helper import CMDCLASS_OVERRIDE
31
+
32
+ # Get the long description from the README file
33
+ HERE = os.path.abspath(os.path.dirname(__file__))
34
+ with open(os.path.join(HERE, "README.md"), encoding="utf-8") as f:
35
+ long_description = f.read()
36
+
37
+ product = "workbench"
38
+ library = ""
39
+ package_info = ["ansys", "api", product, library, "v0"]
40
+ with open(os.path.join(HERE, "src", "ansys", "api", product, library, "VERSION"), encoding="utf-8") as f:
41
+ version = f.read().strip()
42
+
43
+ package_name = "ansys-api-workbench"
44
+ dot_package_name = '.'.join(filter(None, package_info))
45
+
46
+ description = f"Autogenerated python gRPC interface package for {package_name}, built on {datetime.now().strftime('%H:%M:%S on %d %B %Y')}"
47
+
48
+ if __name__ == "__main__":
49
+ setuptools.setup(
50
+ name=package_name,
51
+ version=version,
52
+ author="ANSYS, Inc.",
53
+ author_email="pyansys.core@ansys.com",
54
+ description=description,
55
+ long_description=long_description,
56
+ long_description_content_type='text/markdown',
57
+ url=f"https://github.com/ansys-internal/{package_name}",
58
+ license="MIT",
59
+ python_requires=">=3.7",
60
+ install_requires=["grpcio~=1.47", "protobuf>=3.19,<6"],
61
+ package_dir = {"": "src"},
62
+ packages=setuptools.find_namespace_packages("src", include=("ansys.*",)),
63
+ package_data={
64
+ "": ["*.proto", "*.pyi", "py.typed", "VERSION"],
65
+ },
66
+ entry_points={
67
+ "ansys.tools.protoc_helper.proto_provider": [
68
+ f"{dot_package_name}={dot_package_name}"
69
+ ],
70
+ },
71
+ cmdclass=CMDCLASS_OVERRIDE,
72
+ project_urls={
73
+ "Source": "https://github.com/ansys/ansys-api-workbench/",
74
+ "Tracker": "https://github.com/ansys/ansys-api-workbench/issues/",
75
+ "Documentation": "https://github.com/ansys/ansys-api-workbench/#readme",
76
+ },
77
+ )
@@ -0,0 +1,30 @@
1
+ # Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
2
+ # SPDX-License-Identifier: MIT
3
+ #
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
23
+ """Autogenerated Python gRPC interface package for ansys-api-workbench."""
24
+
25
+ import pathlib
26
+
27
+ __all__ = ["__version__"]
28
+
29
+ with open(pathlib.Path(__file__).parent / "VERSION", encoding="utf-8") as f:
30
+ __version__ = f.read().strip()
@@ -0,0 +1,103 @@
1
+ // Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
2
+ // © 2023 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
3
+ // SPDX-License-Identifier: MIT
4
+ //
5
+ //
6
+ // Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ // of this software and associated documentation files (the "Software"), to deal
8
+ // in the Software without restriction, including without limitation the rights
9
+ // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ // copies of the Software, and to permit persons to whom the Software is
11
+ // furnished to do so, subject to the following conditions:
12
+ //
13
+ // The above copyright notice and this permission notice shall be included in all
14
+ // copies or substantial portions of the Software.
15
+ //
16
+ // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ // SOFTWARE.
23
+
24
+ syntax = "proto3";
25
+ package ansys.api.workbench.v0;
26
+ option csharp_namespace = "Ansys.Api.Workbench.V0";
27
+
28
+ // logger severity levels
29
+ enum LogLevel
30
+ {
31
+ LOG_NONE = 0;
32
+ LOG_FATAL = 1;
33
+ LOG_ERROR = 2;
34
+ LOG_WARNING = 3;
35
+ LOG_INFO = 4;
36
+ LOG_DEBUG = 5;
37
+ }
38
+
39
+ message LogEntry {
40
+ LogLevel level = 1;
41
+ string message = 2;
42
+ }
43
+
44
+ message RunScriptRequest {
45
+ string content = 1;
46
+ LogLevel log_level = 2;
47
+ }
48
+
49
+ message RunScriptResult {
50
+ string error = 1;
51
+ string result = 2;
52
+ }
53
+
54
+ message RunScriptLog {
55
+ repeated LogEntry messages = 1;
56
+ }
57
+
58
+ message RunScriptResponse {
59
+ oneof response {
60
+ RunScriptResult result = 1;
61
+ RunScriptLog log = 2;
62
+ }
63
+ }
64
+
65
+ message UploadFileRequest {
66
+ oneof request {
67
+ string file_name = 1;
68
+ bytes file_content = 2;
69
+ }
70
+ }
71
+
72
+ message UploadFileResponse {
73
+ string error = 1;
74
+ string file_name = 2;
75
+ }
76
+
77
+ message DownloadFileRequest {
78
+ string file_name = 1;
79
+ }
80
+
81
+ message DownloadFileInfo {
82
+ bool is_archive = 1;
83
+ uint64 file_size = 2;
84
+ }
85
+
86
+ message DownloadFileResponse {
87
+ oneof response {
88
+ string error = 1;
89
+ bytes file_content = 2;
90
+ DownloadFileInfo file_info = 3;
91
+ }
92
+ }
93
+
94
+ service WorkbenchService {
95
+ // run the given script
96
+ rpc RunScript(RunScriptRequest) returns (stream RunScriptResponse);
97
+
98
+ // upload a file
99
+ rpc UploadFile(stream UploadFileRequest) returns (UploadFileResponse);
100
+
101
+ // download a file
102
+ rpc DownloadFile(DownloadFileRequest) returns (stream DownloadFileResponse);
103
+ }
@@ -0,0 +1,72 @@
1
+ Metadata-Version: 2.1
2
+ Name: ansys-api-workbench
3
+ Version: 0.2.0
4
+ Summary: Autogenerated python gRPC interface package for ansys-api-workbench, built on 15:27:28 on 12 June 2024
5
+ Home-page: https://github.com/ansys-internal/ansys-api-workbench
6
+ Author: ANSYS, Inc.
7
+ Author-email: pyansys.core@ansys.com
8
+ License: MIT
9
+ Project-URL: Source, https://github.com/ansys/ansys-api-workbench/
10
+ Project-URL: Tracker, https://github.com/ansys/ansys-api-workbench/issues/
11
+ Project-URL: Documentation, https://github.com/ansys/ansys-api-workbench/#readme
12
+ Requires-Python: >=3.7
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ License-File: AUTHORS
16
+ Requires-Dist: grpcio~=1.47
17
+ Requires-Dist: protobuf<6,>=3.19
18
+
19
+ ### ansys-api-workbench gRPC Interface Package
20
+
21
+ This Python package contains the auto-generated gRPC Python interface files for
22
+ the Ansys Workbench Service.
23
+
24
+
25
+ #### Installation
26
+
27
+ Provided that these wheels have been published to public PyPI, they can be
28
+ installed with:
29
+
30
+ ```
31
+ python -m pip install ansys-api-workbench
32
+
33
+ ```
34
+
35
+ #### Build
36
+
37
+ To build the gRPC packages, run:
38
+
39
+ ```
40
+ python -m pip install build
41
+ python -m build
42
+ ```
43
+
44
+ This will create both the source distribution containing just the protofiles
45
+ along with the wheel containing the protofiles and build Python interface
46
+ files.
47
+
48
+ #### Manual deployment
49
+
50
+ After building the packages, manually deploy them with:
51
+
52
+ ```
53
+ python -m pip install twine
54
+ python -m twine upload dist/*
55
+ ```
56
+
57
+ Note that this is automatically done through CI/CD.
58
+
59
+ #### Automatic deployment
60
+
61
+ This repository contains GitHub CI/CD that enables the automatic building of
62
+ source and wheel packages for these gRPC Python interface files. By default,
63
+ these are built on PRs, the main branch, and on tags when pushing. Artifacts
64
+ are uploaded for each PR.
65
+
66
+ To publicly release wheels to PyPI, ensure your branch is up-to-date and then
67
+ push tags. For example, for the version ``v0.5.0``.
68
+
69
+ ```bash
70
+ git tag v0.5.0
71
+ git push --tags
72
+ ```
@@ -0,0 +1,15 @@
1
+ AUTHORS
2
+ LICENSE
3
+ README.md
4
+ pyproject.toml
5
+ setup.py
6
+ src/ansys/api/workbench/VERSION
7
+ src/ansys/api/workbench/__init__.py
8
+ src/ansys/api/workbench/py.typed
9
+ src/ansys/api/workbench/v0/workbench.proto
10
+ src/ansys_api_workbench.egg-info/PKG-INFO
11
+ src/ansys_api_workbench.egg-info/SOURCES.txt
12
+ src/ansys_api_workbench.egg-info/dependency_links.txt
13
+ src/ansys_api_workbench.egg-info/entry_points.txt
14
+ src/ansys_api_workbench.egg-info/requires.txt
15
+ src/ansys_api_workbench.egg-info/top_level.txt
@@ -0,0 +1,2 @@
1
+ [ansys.tools.protoc_helper.proto_provider]
2
+ ansys.api.workbench.v0 = ansys.api.workbench.v0
@@ -0,0 +1,2 @@
1
+ grpcio~=1.47
2
+ protobuf<6,>=3.19