ansys-bdm-api 0.5.dev0__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 BDM API's 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 want to be added to this file,
9
+ # submit a request.
10
+ #
11
+ #
12
+ ANSYS, Inc.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2026 ANSYS, Inc. and/or its affiliates.
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,171 @@
1
+ Metadata-Version: 2.4
2
+ Name: ansys-bdm-api
3
+ Version: 0.5.dev0
4
+ Summary: Python API for BDM
5
+ License: Apache-2.0
6
+ License-File: AUTHORS
7
+ License-File: LICENSE
8
+ Author: ANSYS, Inc.
9
+ Author-email: pyansys.core@ansys.com
10
+ Maintainer: ANSYS, Inc.
11
+ Maintainer-email: pyansys.core@ansys.com
12
+ Requires-Python: >=3.10,<4
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Intended Audience :: Science/Research
15
+ Classifier: License :: OSI Approved :: Apache Software License
16
+ Classifier: Natural Language :: English
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Programming Language :: Python :: 3.14
23
+ Classifier: Topic :: Scientific/Engineering
24
+ Requires-Dist: aioshutil (>=1.3,<2.0)
25
+ Requires-Dist: anyio (>=3.7.1,<5.0.0)
26
+ Requires-Dist: pydantic (>=2.3.0,<3.0.0)
27
+ Description-Content-Type: text/x-rst
28
+
29
+ ##############################
30
+ Blob Management API for Python
31
+ ##############################
32
+
33
+ |python| |pypi| |GH-CI| |codecov| |Apache| |ruff|
34
+
35
+ .. |python| image:: https://img.shields.io/pypi/pyversions/ansys-bdm-api?logo=python&logoColor=white&label=Python
36
+ :target: https://pypi.org/project/ansys-bdm-api/
37
+ :alt: Python
38
+
39
+ .. |pypi| image:: https://img.shields.io/pypi/v/ansys-bdm-api.svg?logo=pypi&logoColor=white&label=PyPI
40
+ :target: https://pypi.org/project/ansys-bdm-api/
41
+ :alt: PyPI
42
+
43
+ .. |GH-CI| image:: https://github.com/ansys/bdm-python-api/actions/workflows/ci_cd_release.yml/badge.svg?label=CI
44
+ :target: https://github.com/ansys/bdm-python-api/actions/workflows/ci_cd_release.yml
45
+ :alt: GH-CI
46
+
47
+ .. |codecov| image:: https://img.shields.io/codecov/c/github/ansys/bdm-python-api
48
+ :target: https://app.codecov.io/gh/ansys/bdm-python-api
49
+ :alt: Codecov
50
+
51
+ .. |Apache| image:: https://img.shields.io/badge/License-Apache2.0-white.svg?labelColor=black
52
+ :target: https://www.apache.org/licenses/
53
+ :alt: Apache
54
+
55
+ .. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
56
+ :target: https://github.com/astral-sh/ruff
57
+ :alt: Ruff
58
+
59
+
60
+ Overview
61
+ ========
62
+
63
+ Blob Data Management (BDM) is a way to manage files and directories through
64
+ abstract references instead of direct file-system paths. In SAF GLOW, BDM is a
65
+ shared technology component that helps applications work with engineering data
66
+ in a scalable and cloud-ready way across different runtime environments.
67
+
68
+ The ``ansys-bdm-api`` package provides the Python interfaces and models for
69
+ working with BDM services. It is built around concepts such as
70
+ ``EntityHandle``, which references a file or directory through metadata, and
71
+ ``Storage Scopes``, which define where data lives and how it is transferred or
72
+ realized when needed.
73
+
74
+ This approach helps reduce unnecessary file copying, improves performance
75
+ through caching, and makes workflows more portable across Windows, Linux,
76
+ cloud, and on-premises environments. It also supports safer and more
77
+ consistent handling of large engineering datasets and directory structures.
78
+
79
+
80
+ Installation
81
+ ============
82
+
83
+ Ensure you have all the necessary `prerequisites`_. Then, refer to the
84
+ `installation guidelines`_ for detailed instructions on how to install the
85
+ project in your system.
86
+
87
+
88
+ Documentation
89
+ =============
90
+
91
+ The `official documentation`_ of the Blob Management API for Python contains the following chapters:
92
+
93
+ - `Getting started`_. This section provides a brief overview and instructions on
94
+ how to get started with the project. It typically includes information on how
95
+ to install the project, set up any necessary dependencies, and run a basic
96
+ example or test to ensure everything is functioning correctly.
97
+
98
+ - `User guide`_. The user guide section offers detailed documentation and
99
+ instructions on how to use the project. It provides comprehensive explanations
100
+ of the project's features, functionalities, and configuration options. The
101
+ user guide aims to help users understand the project's concepts, best
102
+ practices, and recommended workflows.
103
+
104
+ - `API reference`_. The API reference section provides detailed documentation
105
+ for the project's application programming interface (API). It includes
106
+ information about classes, functions, methods, and their parameters, return
107
+ values, and usage examples. This reference helps developers understand the
108
+ available API endpoints, their functionalities, and how to interact with them
109
+ programmatically.
110
+
111
+ - `Examples`_. The examples section showcases practical code examples that
112
+ demonstrate how to use the project in real-world scenarios. It provides sample
113
+ code snippets or complete scripts that illustrate different use cases or
114
+ demonstrate specific features of the project. Examples serve as practical
115
+ references for developers, helping them understand how to apply the project to
116
+ their own applications.
117
+
118
+ - `Contribute`_. This section provides guidelines and instructions on how to
119
+ contribute to the project. It includes information on how to set up the
120
+ development environment, run tests, submit pull requests, and follow
121
+ contribution guidelines.
122
+
123
+
124
+ Troubleshooting
125
+ ===============
126
+
127
+ For troubleshooting or reporting issues, please open an issue in the project
128
+ repository.
129
+
130
+ Please follow these steps to report an issue:
131
+
132
+ - Go to the project repository.
133
+ - Click on the ``Issues`` tab.
134
+ - Click on the ``New Issue`` button.
135
+ - Provide a clear and detailed description of the issue you are facing.
136
+ - Include any relevant error messages, code snippets, or screenshots.
137
+
138
+ Additionally, you can refer to the `official documentation`_ for additional
139
+ resources and troubleshooting guides.
140
+
141
+
142
+ License
143
+ =======
144
+
145
+ You can find the full text of the license in the `LICENSE`_ file.
146
+
147
+
148
+ Changelog
149
+ =========
150
+
151
+ The changelog section provides a summary of notable changes for each version of
152
+ Blob Management API for Python. It helps you keep track of updates, bug
153
+ fixes, new features, and improvements made to the project over time.
154
+
155
+ To view the complete changelog, visit the project repository and navigate
156
+ to the `CHANGELOG`_ file. It provides a comprehensive list of changes
157
+ categorized by version, along with brief descriptions of each change.
158
+
159
+
160
+ .. _prerequisites: https://bdm-python-api.docs.solutions.ansys.com/version/stable/getting-started.html#prerequisites
161
+ .. _installation guidelines: https://bdm-python-api.docs.solutions.ansys.com/version/stable/getting-started.html#installation
162
+ .. _official documentation: https://bdm-python-api.docs.solutions.ansys.com
163
+ .. _Getting started: https://bdm-python-api.docs.solutions.ansys.com/version/stable/getting-started.html
164
+ .. _User guide: https://bdm-python-api.docs.solutions.ansys.com/version/stable/user-guide.html
165
+ .. _API reference: https://bdm-python-api.docs.solutions.ansys.com/version/stable/api/index.html
166
+ .. _Examples: https://bdm-python-api.docs.solutions.ansys.com/version/stable/examples.html
167
+ .. _Contribute: https://bdm-python-api.docs.solutions.ansys.com/version/stable/contribute.html
168
+ .. _LICENSE: https://github.com/ansys/bdm-python-api/blob/main/LICENSE
169
+ .. _CHANGELOG: https://github.com/ansys/bdm-python-api/blob/main/CHANGELOG.md
170
+
171
+
@@ -0,0 +1,142 @@
1
+ ##############################
2
+ Blob Management API for Python
3
+ ##############################
4
+
5
+ |python| |pypi| |GH-CI| |codecov| |Apache| |ruff|
6
+
7
+ .. |python| image:: https://img.shields.io/pypi/pyversions/ansys-bdm-api?logo=python&logoColor=white&label=Python
8
+ :target: https://pypi.org/project/ansys-bdm-api/
9
+ :alt: Python
10
+
11
+ .. |pypi| image:: https://img.shields.io/pypi/v/ansys-bdm-api.svg?logo=pypi&logoColor=white&label=PyPI
12
+ :target: https://pypi.org/project/ansys-bdm-api/
13
+ :alt: PyPI
14
+
15
+ .. |GH-CI| image:: https://github.com/ansys/bdm-python-api/actions/workflows/ci_cd_release.yml/badge.svg?label=CI
16
+ :target: https://github.com/ansys/bdm-python-api/actions/workflows/ci_cd_release.yml
17
+ :alt: GH-CI
18
+
19
+ .. |codecov| image:: https://img.shields.io/codecov/c/github/ansys/bdm-python-api
20
+ :target: https://app.codecov.io/gh/ansys/bdm-python-api
21
+ :alt: Codecov
22
+
23
+ .. |Apache| image:: https://img.shields.io/badge/License-Apache2.0-white.svg?labelColor=black
24
+ :target: https://www.apache.org/licenses/
25
+ :alt: Apache
26
+
27
+ .. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
28
+ :target: https://github.com/astral-sh/ruff
29
+ :alt: Ruff
30
+
31
+
32
+ Overview
33
+ ========
34
+
35
+ Blob Data Management (BDM) is a way to manage files and directories through
36
+ abstract references instead of direct file-system paths. In SAF GLOW, BDM is a
37
+ shared technology component that helps applications work with engineering data
38
+ in a scalable and cloud-ready way across different runtime environments.
39
+
40
+ The ``ansys-bdm-api`` package provides the Python interfaces and models for
41
+ working with BDM services. It is built around concepts such as
42
+ ``EntityHandle``, which references a file or directory through metadata, and
43
+ ``Storage Scopes``, which define where data lives and how it is transferred or
44
+ realized when needed.
45
+
46
+ This approach helps reduce unnecessary file copying, improves performance
47
+ through caching, and makes workflows more portable across Windows, Linux,
48
+ cloud, and on-premises environments. It also supports safer and more
49
+ consistent handling of large engineering datasets and directory structures.
50
+
51
+
52
+ Installation
53
+ ============
54
+
55
+ Ensure you have all the necessary `prerequisites`_. Then, refer to the
56
+ `installation guidelines`_ for detailed instructions on how to install the
57
+ project in your system.
58
+
59
+
60
+ Documentation
61
+ =============
62
+
63
+ The `official documentation`_ of the Blob Management API for Python contains the following chapters:
64
+
65
+ - `Getting started`_. This section provides a brief overview and instructions on
66
+ how to get started with the project. It typically includes information on how
67
+ to install the project, set up any necessary dependencies, and run a basic
68
+ example or test to ensure everything is functioning correctly.
69
+
70
+ - `User guide`_. The user guide section offers detailed documentation and
71
+ instructions on how to use the project. It provides comprehensive explanations
72
+ of the project's features, functionalities, and configuration options. The
73
+ user guide aims to help users understand the project's concepts, best
74
+ practices, and recommended workflows.
75
+
76
+ - `API reference`_. The API reference section provides detailed documentation
77
+ for the project's application programming interface (API). It includes
78
+ information about classes, functions, methods, and their parameters, return
79
+ values, and usage examples. This reference helps developers understand the
80
+ available API endpoints, their functionalities, and how to interact with them
81
+ programmatically.
82
+
83
+ - `Examples`_. The examples section showcases practical code examples that
84
+ demonstrate how to use the project in real-world scenarios. It provides sample
85
+ code snippets or complete scripts that illustrate different use cases or
86
+ demonstrate specific features of the project. Examples serve as practical
87
+ references for developers, helping them understand how to apply the project to
88
+ their own applications.
89
+
90
+ - `Contribute`_. This section provides guidelines and instructions on how to
91
+ contribute to the project. It includes information on how to set up the
92
+ development environment, run tests, submit pull requests, and follow
93
+ contribution guidelines.
94
+
95
+
96
+ Troubleshooting
97
+ ===============
98
+
99
+ For troubleshooting or reporting issues, please open an issue in the project
100
+ repository.
101
+
102
+ Please follow these steps to report an issue:
103
+
104
+ - Go to the project repository.
105
+ - Click on the ``Issues`` tab.
106
+ - Click on the ``New Issue`` button.
107
+ - Provide a clear and detailed description of the issue you are facing.
108
+ - Include any relevant error messages, code snippets, or screenshots.
109
+
110
+ Additionally, you can refer to the `official documentation`_ for additional
111
+ resources and troubleshooting guides.
112
+
113
+
114
+ License
115
+ =======
116
+
117
+ You can find the full text of the license in the `LICENSE`_ file.
118
+
119
+
120
+ Changelog
121
+ =========
122
+
123
+ The changelog section provides a summary of notable changes for each version of
124
+ Blob Management API for Python. It helps you keep track of updates, bug
125
+ fixes, new features, and improvements made to the project over time.
126
+
127
+ To view the complete changelog, visit the project repository and navigate
128
+ to the `CHANGELOG`_ file. It provides a comprehensive list of changes
129
+ categorized by version, along with brief descriptions of each change.
130
+
131
+
132
+ .. _prerequisites: https://bdm-python-api.docs.solutions.ansys.com/version/stable/getting-started.html#prerequisites
133
+ .. _installation guidelines: https://bdm-python-api.docs.solutions.ansys.com/version/stable/getting-started.html#installation
134
+ .. _official documentation: https://bdm-python-api.docs.solutions.ansys.com
135
+ .. _Getting started: https://bdm-python-api.docs.solutions.ansys.com/version/stable/getting-started.html
136
+ .. _User guide: https://bdm-python-api.docs.solutions.ansys.com/version/stable/user-guide.html
137
+ .. _API reference: https://bdm-python-api.docs.solutions.ansys.com/version/stable/api/index.html
138
+ .. _Examples: https://bdm-python-api.docs.solutions.ansys.com/version/stable/examples.html
139
+ .. _Contribute: https://bdm-python-api.docs.solutions.ansys.com/version/stable/contribute.html
140
+ .. _LICENSE: https://github.com/ansys/bdm-python-api/blob/main/LICENSE
141
+ .. _CHANGELOG: https://github.com/ansys/bdm-python-api/blob/main/CHANGELOG.md
142
+
@@ -0,0 +1,132 @@
1
+ [build-system]
2
+ build-backend = "poetry.core.masonry.api"
3
+ requires = [ "poetry-core>=2.0.0" ]
4
+
5
+ [tool.poetry]
6
+ name = "ansys-bdm-api"
7
+ version = "0.5.dev0"
8
+ description = "Python API for BDM"
9
+ license = "Apache-2.0"
10
+ authors = [ "ANSYS, Inc. <pyansys.core@ansys.com>" ]
11
+ maintainers = [ "ANSYS, Inc. <pyansys.core@ansys.com>" ]
12
+ readme = "README.rst"
13
+ classifiers = [
14
+ "Development Status :: 3 - Alpha",
15
+ "Intended Audience :: Science/Research",
16
+ "License :: OSI Approved :: Apache Software License",
17
+ "Natural Language :: English",
18
+ "Programming Language :: Python :: 3",
19
+ "Programming Language :: Python :: 3.10",
20
+ "Programming Language :: Python :: 3.11",
21
+ "Programming Language :: Python :: 3.12",
22
+ "Programming Language :: Python :: 3.13",
23
+ "Programming Language :: Python :: 3.14",
24
+ "Topic :: Scientific/Engineering",
25
+ ]
26
+ packages = [
27
+ { include = "ansys", from = "src" },
28
+ { include = "ansys/bdm/api/py.typed", from = "src" },
29
+ { include = "ansys/bdm/api", from = "src" },
30
+ ]
31
+
32
+ [[tool.poetry.source]]
33
+ name = "PyPI"
34
+ priority = "primary"
35
+
36
+ [tool.poetry.dependencies]
37
+ python = ">=3.10,<4"
38
+ pydantic = "^2.3.0"
39
+ anyio = ">=3.7.1,<5.0.0"
40
+ aioshutil = "^1.3"
41
+
42
+ [tool.poetry.group.doc]
43
+ optional = true
44
+ [tool.poetry.group.doc.dependencies]
45
+ ansys-sphinx-theme = { extras = [ "autoapi" ], version = "^1.7.0", python = ">=3.12" }
46
+ autodoc-pydantic = { version = "^2.2.0", python = ">=3.12" }
47
+ numpydoc = { version = "^1.10.0", python = ">=3.12" }
48
+ sphinx = { version = "^9.1.0", python = ">=3.12" }
49
+ sphinx-autodoc-typehints = { version = "^3.6.3", python = ">=3.12" }
50
+ sphinx-copybutton = { version = "^0.5.2", python = ">=3.12" }
51
+ sphinx-design = { version = "^0.7.0", python = ">=3.12" }
52
+ tox = { version = "^4.38.0", python = ">=3.12" }
53
+
54
+ [tool.poetry.group.tests]
55
+ optional = true
56
+ [tool.poetry.group.tests.dependencies]
57
+ coverage = "^6.4.1"
58
+ filelock = "^3.8.0"
59
+ mock = "^4.0.3"
60
+ pytest = "^9.0.3"
61
+ pytest-asyncio = "^1.3.0"
62
+ pytest-cov = "^4.0.0"
63
+ pytest-html = "^4.1.1"
64
+ pytest-md = "^0.2.0"
65
+ pytest-mock = "^3.10.0"
66
+ pytest-timeout = "^2.3.1"
67
+ pytest-xdist = "^3.6.1"
68
+
69
+ [tool.ruff]
70
+ line-length = 120
71
+ extend-exclude = [
72
+ "conf.py",
73
+ ]
74
+
75
+ # in same order as in https://docs.astral.sh/ruff/rules
76
+ lint.select = [
77
+ "A", # flake8-builtins
78
+ "ASYNC", # flake8-async
79
+ "B", # flake8-bugbear
80
+ "C4", # flake8-comprehensions
81
+ "C90", # mccabe
82
+ "COM", # flake8-commas
83
+ "E", # pycodestyle - error
84
+ "F", # pyflakes
85
+ "FAST", # fastapi
86
+ "I", # isort
87
+ "LOG", # flake8-logging
88
+ "N", # pep8-naming
89
+ "PIE", # flake8-pie
90
+ "PT", # flake8-pytest-style
91
+ "PTH", # flake8-use-pathlib
92
+ "PYI", # flake8-pyi
93
+ "Q", # flake8-quotes
94
+ "RUF100", # ruff-specific rules: unused noqa
95
+ "SIM", # flake8-simplify
96
+ "TC", # flake8-type-checking
97
+ "UP", # pyupgrade
98
+ "W", # pycodestyle - warning
99
+ ]
100
+ lint.ignore = [ "PYI034" ]
101
+ lint.flake8-pytest-style.mark-parentheses = false
102
+ lint.isort.force-sort-within-sections = true
103
+ lint.isort.known-first-party = [ "src", "doc", "tests" ]
104
+
105
+ [tool.coverage.run]
106
+ source = [ "ansys.bdm" ]
107
+ omit = [
108
+ "read_toml.py",
109
+ "tests/*",
110
+ ]
111
+
112
+ [tool.coverage.report]
113
+ show_missing = true
114
+
115
+ [tool.pyright]
116
+ venvPath = "."
117
+ venv = ".venv"
118
+ extraPaths = [ "src" ]
119
+ include = [
120
+ "src/ansys/bdm/api",
121
+ "tests",
122
+ ]
123
+ strict = [
124
+ "src/ansys/bdm/api",
125
+ "tests",
126
+ ]
127
+
128
+ [tool.bandit]
129
+ exclude_dirs = [ ".venv", ".tox", "tests", "setup_environment.py" ]
130
+
131
+ [build-system-requirements]
132
+ build-system-version = "2.3.2"