From 64023b4737d621ec72da981a382e4cf67a9386db Mon Sep 17 00:00:00 2001 From: Alex Kaszynski Date: Fri, 25 Mar 2022 18:15:52 +0100 Subject: [PATCH] add library name guidance --- .../library_description/library_names.rst | 29 ++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/doc/source/library_description/library_names.rst b/doc/source/library_description/library_names.rst index 819a1fa96..d2b930f9a 100644 --- a/doc/source/library_description/library_names.rst +++ b/doc/source/library_description/library_names.rst @@ -20,7 +20,34 @@ Using long Python library names provides two primary advantages: - `Namespace Packages`_ can be used to designate official Ansys packages - Consistent branding and style can be applied to PyAnsys libraries - + + +gRPC Interface Package +---------------------- +Lower level gRPC interface packages like `ansys-api-mapdl`_ should always be +named ``ansys-api-`` or may contain an additional level with +``ansys-api--``. + +This is to standarize the API packages: + +.. code:: + + ─ansys + │ ├───api + │ │ ├─── + │ │ │ ├───VERSION + │ │ │ ├───v1 + │ │ │ │ ├───sample.proto + + +Where the package name within ``sample.proto`` would be: + +.. code:: + + package ansys.api..v1; + + .. _PyMAPDL: https://github.com/pyansys/pymapdl .. _PyAEDT: https://github.com/pyansys/PyAEDT .. _Namespace Packages: https://packaging.python.org/guides/packaging-namespace-packages/ +.. _ansys-api-mapdl: https://pypi.org/project/ansys-api-mapdl/