feat: add the dioptra client to the dioptra.client namespace

This update formalizes the `DioptraClient` class in examples/scripts/client.py by adding it to the
dioptra package and adding documentation for it.

docs/source/index.rst

@@ -59,6 +59,7 @@ Email us: [email protected]
    user-guide/generics-plugin-system
    user-guide/task-plugins-collection
    user-guide/api-reference-sdk
+   user-guide/api-reference-client
    user-guide/api-reference-restapi
 
 .. toctree::

docs/source/user-guide/api-reference-client.rst

@@ -0,0 +1,28 @@
+.. This Software (Dioptra) is being made available as a public service by the
+.. National Institute of Standards and Technology (NIST), an Agency of the United
+.. States Department of Commerce. This software was developed in part by employees of
+.. NIST and in part by NIST contractors. Copyright in portions of this software that
+.. were developed by NIST contractors has been licensed or assigned to NIST. Pursuant
+.. to Title 17 United States Code Section 105, works of NIST employees are not
+.. subject to copyright protection in the United States. However, NIST may hold
+.. international copyright in software created by its employees and domestic
+.. copyright (or licensing rights) in portions of software that were assigned or
+.. licensed to NIST. To the extent that NIST holds copyright in this software, it is
+.. being made available under the Creative Commons Attribution 4.0 International
+.. license (CC BY 4.0). The disclaimers of the CC BY 4.0 license apply to all parts
+.. of the software developed or licensed by NIST.
+..
+.. ACCESS THE FULL CC BY 4.0 LICENSE HERE:
+.. https://creativecommons.org/licenses/by/4.0/legalcode
+
+.. _user-guide-api-reference-sdk-client:
+
+Testbed Client API Reference
+============================
+
+.. include:: /_glossary_note.rst
+
+.. automodule:: dioptra.client
+   :members:
+   :undoc-members:
+   :show-inheritance:

src/dioptra/client/__init__.py

@@ -0,0 +1,21 @@
+# This Software (Dioptra) is being made available as a public service by the
+# National Institute of Standards and Technology (NIST), an Agency of the United
+# States Department of Commerce. This software was developed in part by employees of
+# NIST and in part by NIST contractors. Copyright in portions of this software that
+# were developed by NIST contractors has been licensed or assigned to NIST. Pursuant
+# to Title 17 United States Code Section 105, works of NIST employees are not
+# subject to copyright protection in the United States. However, NIST may hold
+# international copyright in software created by its employees and domestic
+# copyright (or licensing rights) in portions of software that were assigned or
+# licensed to NIST. To the extent that NIST holds copyright in this software, it is
+# being made available under the Creative Commons Attribution 4.0 International
+# license (CC BY 4.0). The disclaimers of the CC BY 4.0 license apply to all parts
+# of the software developed or licensed by NIST.
+#
+# ACCESS THE FULL CC BY 4.0 LICENSE HERE:
+# https://creativecommons.org/licenses/by/4.0/legalcode
+from __future__ import annotations
+
+from ._client import DioptraClient
+
+__all__ = ["DioptraClient"]

src/dioptra/client/__version__.py

@@ -0,0 +1,17 @@
+# This Software (Dioptra) is being made available as a public service by the
+# National Institute of Standards and Technology (NIST), an Agency of the United
+# States Department of Commerce. This software was developed in part by employees of
+# NIST and in part by NIST contractors. Copyright in portions of this software that
+# were developed by NIST contractors has been licensed or assigned to NIST. Pursuant
+# to Title 17 United States Code Section 105, works of NIST employees are not
+# subject to copyright protection in the United States. However, NIST may hold
+# international copyright in software created by its employees and domestic
+# copyright (or licensing rights) in portions of software that were assigned or
+# licensed to NIST. To the extent that NIST holds copyright in this software, it is
+# being made available under the Creative Commons Attribution 4.0 International
+# license (CC BY 4.0). The disclaimers of the CC BY 4.0 license apply to all parts
+# of the software developed or licensed by NIST.
+#
+# ACCESS THE FULL CC BY 4.0 LICENSE HERE:
+# https://creativecommons.org/licenses/by/4.0/legalcode
+__version__ = "0.0.0"