File tree Expand file tree Collapse file tree 1 file changed +28
-1
lines changed
doc/source/library_description Expand file tree Collapse file tree 1 file changed +28
-1
lines changed Original file line number Diff line number Diff line change @@ -20,7 +20,34 @@ Using long Python library names provides two primary advantages:
20
20
- `Namespace Packages `_ can be used to designate official
21
21
Ansys packages
22
22
- Consistent branding and style can be applied to PyAnsys libraries
23
-
23
+
24
+
25
+ gRPC Interface Package
26
+ ----------------------
27
+ Lower level gRPC interface packages like `ansys-api-mapdl `_ should always be
28
+ named ``ansys-api-<product/service> `` or may contain an additional level with
29
+ ``ansys-api-<product/service>-<secondlevel> ``.
30
+
31
+ This is to standarize the API packages:
32
+
33
+ .. code ::
34
+
35
+ ─ansys
36
+ │ ├───api
37
+ │ │ ├───<product/service>
38
+ │ │ │ ├───VERSION
39
+ │ │ │ ├───v1
40
+ │ │ │ │ ├───sample.proto
41
+
42
+
43
+ Where the package name within ``sample.proto `` would be:
44
+
45
+ .. code ::
46
+
47
+ package ansys.api.<product/service>.v1;
48
+
49
+
24
50
.. _PyMAPDL : https://github.com/pyansys/pymapdl
25
51
.. _PyAEDT : https://github.com/pyansys/PyAEDT
26
52
.. _Namespace Packages : https://packaging.python.org/guides/packaging-namespace-packages/
53
+ .. _ansys-api-mapdl : https://pypi.org/project/ansys-api-mapdl/
You can’t perform that action at this time.
0 commit comments