Skip to content

add library name guidance #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2022
Merged

add library name guidance #66

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion doc/source/library_description/library_names.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-<product/service>`` or may contain an additional level with
``ansys-api-<product/service>-<secondlevel>``.

This is to standarize the API packages:

.. code::

─ansys
│ ├───api
│ │ ├───<product/service>
│ │ │ ├───VERSION
│ │ │ ├───v1
│ │ │ │ ├───sample.proto


Where the package name within ``sample.proto`` would be:

.. code::

package ansys.api.<product/service>.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/