chore(python-client): rename python package to streampipes

Signed-off-by: bossenti <[email protected]>
apache · Feb 6, 2023 · 8a6ef00 · 8a6ef00
1 parent a73dee9
commit 8a6ef00
Show file tree

Hide file tree

Showing 51 changed files with 248 additions and 193 deletions.
diff --git a/streampipes-client-python/.pre-commit-config.yaml b/streampipes-client-python/.pre-commit-config.yaml
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-files: streampipes_client/|tests/
+files: streampipes/|tests/
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.2.0

diff --git a/streampipes-client-python/Makefile b/streampipes-client-python/Makefile
@@ -24,15 +24,15 @@ doc:
 
 .PHONY: lint
 lint:
-	flake8 streampipes_client --max-line-length 120
+	flake8 streampipes --max-line-length 120
 
 .PHONY: livedoc
 livedoc: doc
 	mkdocs serve --dirtyreload
 
 .PHONY: mypy
 mypy:
-	mypy streampipes_client --warn-unused-ignores --warn-redundant-casts --pretty
+	mypy streampipes --warn-unused-ignores --warn-redundant-casts --pretty
 
 .PHONY: rebase
 rebase:
@@ -41,14 +41,14 @@ rebase:
 .PHONY: reformat-all
 reformat-all:
 	pyupgrade --py38 --keep-runtime-typing
-	autoflake -r --remove-all-unused-imports --expand-star-imports --in-place streampipes_client tests
-	isort --profile black streampipes_client tests
-	black --line-length=120 streampipes_client tests
+	autoflake -r --remove-all-unused-imports --expand-star-imports --in-place streampipes tests
+	isort --profile black streampipes tests
+	black --line-length=120 streampipes tests
 
 .PHONY: pre-commit
 pre-commit:
 	pre-commit run --verbose --all-files
 
 .PHONY: unit-tests
 unit-tests:
-	pytest --cov=streampipes_client tests/ --cov-fail-under=90 --cov-report term-missing --no-cov-on-fail
+	pytest --cov=streampipes tests/ --cov-fail-under=90 --cov-report term-missing --no-cov-on-fail
diff --git a/streampipes-client-python/README.md b/streampipes-client-python/README.md
@@ -46,28 +46,54 @@ and the amazing universe of data analytics libraries in Python. </p>
 As a quick example, we demonstrate how to set up and configure a StreamPipes client.
 
 ```python
->>> from streampipes_client.client import StreamPipesClient
->>> from streampipes_client.client.client_config import StreamPipesClientConfig
->>> from streampipes_client.client.credential_provider import StreamPipesApiKeyCredentials
+>> > from streampipes.client import StreamPipesClient
+>> > from streampipes.client.client_config import StreamPipesClientConfig
+>> > from streampipes.client.credential_provider import StreamPipesApiKeyCredentials
 
->>> config = StreamPipesClientConfig(
-...    credential_provider=StreamPipesApiKeyCredentials(
-...         username="[email protected]",
-...         api_key="DEMO-KEY",
-...         ),
-...     host_address="localhost",
-...     http_disabled=True,
-...     port=80                  
+>> > config = StreamPipesClientConfig(
+    ...
+credential_provider = StreamPipesApiKeyCredentials(
+    ...
+username = "[email protected]",
+           ...
+api_key = "DEMO-KEY",
+          ...         ),
+...
+host_address = "localhost",
+               ...
+http_disabled = True,
+                ...
+port = 80
 ...)
 
->>> client = StreamPipesClient(client_config=config)
->>> client.describe()
+>> > client = StreamPipesClient(client_config=config)
+>> > client.describe()
 
-Hi there!
-You are connected to a StreamPipes instance running at http://localhost:80.
-The following StreamPipes resources are available with this client:
-6x DataStreams
-1x DataLakeMeasures
+Hi
+there!
+You
+are
+connected
+to
+a
+StreamPipes
+instance
+running
+at
+http: // localhost: 80.
+The
+following
+StreamPipes
+resources
+are
+available
+with this client:
+    6
+x
+DataStreams
+1
+x
+DataLakeMeasures
 ```
 
 For more information about how to use the StreamPipes client visit our [introduction example]().
diff --git a/streampipes-client-python/docs/examples/1-introduction-to-streampipes-python-client.ipynb b/streampipes-client-python/docs/examples/1-introduction-to-streampipes-python-client.ipynb
@@ -63,9 +63,9 @@
    "execution_count": 3,
    "outputs": [],
    "source": [
-    "from streampipes_client.client import StreamPipesClient\n",
-    "from streampipes_client.client.client_config import StreamPipesClientConfig\n",
-    "from streampipes_client.client.credential_provider import StreamPipesApiKeyCredentials"
+    "from streampipes.client import StreamPipesClient\n",
+    "from streampipes.client.config import StreamPipesClientConfig\n",
+    "from streampipes.client.credential_provider import StreamPipesApiKeyCredentials"
    ],
    "metadata": {
     "collapsed": false

diff --git a/...mpipes-client-python/docs/examples/2-extracting-data-from-the-streampipes-data-lake.ipynb b/...mpipes-client-python/docs/examples/2-extracting-data-from-the-streampipes-data-lake.ipynb
@@ -19,9 +19,9 @@
    "execution_count": 1,
    "outputs": [],
    "source": [
-    "from streampipes_client.client import StreamPipesClient\n",
-    "from streampipes_client.client.client_config import StreamPipesClientConfig\n",
-    "from streampipes_client.client.credential_provider import StreamPipesApiKeyCredentials"
+    "from streampipes.client import StreamPipesClient\n",
+    "from streampipes.client.config import StreamPipesClientConfig\n",
+    "from streampipes.client.credential_provider import StreamPipesApiKeyCredentials"
    ],
    "metadata": {
     "collapsed": false

diff --git a/...es-client-python/docs/examples/3-getting-live-data-from-the-streampipes-data-stream.ipynb b/...es-client-python/docs/examples/3-getting-live-data-from-the-streampipes-data-stream.ipynb
@@ -15,9 +15,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from streampipes_client.client import StreamPipesClient\n",
-    "from streampipes_client.client.client_config import StreamPipesClientConfig\n",
-    "from streampipes_client.client.credential_provider import StreamPipesApiKeyCredentials"
+    "from streampipes.client import StreamPipesClient\n",
+    "from streampipes.client.config import StreamPipesClientConfig\n",
+    "from streampipes.client.credential_provider import StreamPipesApiKeyCredentials"
    ]
   },
   {
@@ -238,10 +238,10 @@
     "import pandas as pd\n",
     "from datetime import datetime\n",
     "import matplotlib.pyplot as plt\n",
-    "from streampipes_client.functions.function_handler import FunctionHandler\n",
-    "from streampipes_client.functions.registration import Registration\n",
-    "from streampipes_client.functions.streampipes_function import StreamPipesFunction\n",
-    "from streampipes_client.functions.utils.function_context import FunctionContext\n",
+    "from streampipes.functions.function_handler import FunctionHandler\n",
+    "from streampipes.functions.registration import Registration\n",
+    "from streampipes.functions.streampipes_function import StreamPipesFunction\n",
+    "from streampipes.functions.utils.function_context import FunctionContext\n",
     "\n",
     "class ExampleFunction(StreamPipesFunction):\n",
     "\n",
@@ -610,4 +610,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/streampipes-client-python/docs/getting-started/quickstart.md b/streampipes-client-python/docs/getting-started/quickstart.md
@@ -21,35 +21,61 @@
 As a quick example, we demonstrate how to set up and configure a StreamPipes client.
 
 ```python
->>> from streampipes_client.client import StreamPipesClient
->>> from streampipes_client.client.client_config import StreamPipesClientConfig
->>> from streampipes_client.client.credential_provider import StreamPipesApiKeyCredentials
-
->>> config = StreamPipesClientConfig(
-...    credential_provider=StreamPipesApiKeyCredentials(
-...         username="[email protected]",
-...         api_key="DEMO-KEY",
-...         ),
-...     host_address="localhost",
-...     http_disabled=True,
-...     port=80                  
+>> > from streampipes.client import StreamPipesClient
+>> > from streampipes.client.client_config import StreamPipesClientConfig
+>> > from streampipes.client.credential_provider import StreamPipesApiKeyCredentials
+
+>> > config = StreamPipesClientConfig(
+    ...
+credential_provider = StreamPipesApiKeyCredentials(
+    ...
+username = "[email protected]",
+           ...
+api_key = "DEMO-KEY",
+          ...         ),
+...
+host_address = "localhost",
+               ...
+http_disabled = True,
+                ...
+port = 80
 ...)
 
->>> client = StreamPipesClient(client_config=config)
->>> client.describe()
+>> > client = StreamPipesClient(client_config=config)
+>> > client.describe()
 
-Hi there!
-You are connected to a StreamPipes instance running at http://localhost:80.
-The following StreamPipes resources are available with this client:
-6x DataStreams
-1x DataLakeMeasures
+Hi
+there!
+You
+are
+connected
+to
+a
+StreamPipes
+instance
+running
+at
+http: // localhost: 80.
+The
+following
+StreamPipes
+resources
+are
+available
+with this client:
+    6
+x
+DataStreams
+1
+x
+DataLakeMeasures
 ```
 <br>
 Alternatively, you can provide your credentials via environment variables.
 Simply define your credential provider as follows:
 
 ```python
->>> from streampipes_client.client.credential_provider import StreamPipesApiKeyCredentials
+>> > from streampipes.client.credential_provider import StreamPipesApiKeyCredentials
 
 StreamPipesApiKeyCredentials.from_env(username_env="USER", api_key_env="API-KEY")
 ```

diff --git a/streampipes-client-python/docs/index.md b/streampipes-client-python/docs/index.md
@@ -36,18 +36,9 @@ and the amazing universe of data analytics libraries in Python. </p>
 
 <br>
 
-** ❗❗❗IMPORTANT ❗❗❗**
-<br>
-<br>
-**The current version of this Python client is still in alpha phase at best.**
+**💡 The current version of this Python client is still a beta version.**
 <br>
 **This means that it is still heavily under development, which may result in frequent and extensive API changes, unstable behavior, etc.**
-<br>
-**Please consider it only as a sneak preview.**
-<br>
-<br>
-**❗❗❗ IMPORTANT ❗❗❗**
-
 <br>
 
 ## ⚡️ Quickstart
@@ -56,41 +47,53 @@ As a quick example, we demonstrate how to set up and configure a StreamPipes cli
 In addition, we will get the available data lake measures out of StreamPipes.
 
 ```python
->>> from streampipes_client.client import StreamPipesClient
->>> from streampipes_client.client.client_config import StreamPipesClientConfig
->>> from streampipes_client.client.credential_provider import StreamPipesApiKeyCredentials
-
->>> config = StreamPipesClientConfig(
-...    credential_provider=StreamPipesApiKeyCredentials(
-...         username="[email protected]",
-...         api_key="DEMO-KEY",
-...         ),
-...     host_address="localhost",
-...     http_disabled=True,
-...     port=80                  
+>> > from streampipes.client import StreamPipesClient
+>> > from streampipes.client.client_config import StreamPipesClientConfig
+>> > from streampipes.client.credential_provider import StreamPipesApiKeyCredentials
+
+>> > config = StreamPipesClientConfig(
+    ...
+credential_provider = StreamPipesApiKeyCredentials(
+    ...
+username = "[email protected]",
+           ...
+api_key = "DEMO-KEY",
+          ...         ),
+...
+host_address = "localhost",
+               ...
+http_disabled = True,
+                ...
+port = 80
 ...)
 
->>> client = StreamPipesClient(client_config=config)
+>> > client = StreamPipesClient(client_config=config)
 
 # get all available datat lake measures
->>> measures = client.dataLakeMeasureApi.all()
+>> > measures = client.dataLakeMeasureApi.all()
 
 # get amount of retrieved measures
->>> len(measures)
+>> > len(measures)
 1
 
 # inspect the data lake measures as pandas dataframe
->>> measures.to_pandas()
-    measure_name timestamp_field  ... pipeline_is_running num_event_properties
-0           test   s0::timestamp  ...               False                    2
+>> > measures.to_pandas()
+measure_name
+timestamp_field...pipeline_is_running
+num_event_properties
+0
+test
+s0::timestamp...
+False
+2
 [1 rows x 6 columns]
 ```
 <br>
 Alternatively, you can provide your credentials via environment variables.
 Simply define your credential provider as follows:
 
 ```python
->>> from streampipes_client.client.credential_provider import StreamPipesApiKeyCredentials
+>> > from streampipes.client.credential_provider import StreamPipesApiKeyCredentials
 
 StreamPipesApiKeyCredentials.from_env(username_env="USER", api_key_env="API-KEY")
 ```

diff --git a/streampipes-client-python/docs/scripts/gen_ref_pages.py b/streampipes-client-python/docs/scripts/gen_ref_pages.py
@@ -21,9 +21,9 @@
 
 nav = mkdocs_gen_files.Nav()
 
-for path in sorted(Path("streampipes_client").rglob("*.py")):
-    module_path = path.relative_to("streampipes_client").with_suffix("")
-    doc_path = path.relative_to("streampipes_client").with_suffix(".md")
+for path in sorted(Path("streampipes").rglob("*.py")):
+    module_path = path.relative_to("streampipes").with_suffix("")
+    doc_path = path.relative_to("streampipes").with_suffix(".md")
     full_doc_path = Path("reference", doc_path)
 
     parts = list(module_path.parts)
@@ -42,7 +42,7 @@
 
     with mkdocs_gen_files.open(full_doc_path, "w+") as fd:
         identifier = ".".join(parts)
-        print(f"::: streampipes_client.{identifier}", file=fd)
+        print(f"::: streampipes.{identifier}", file=fd)
 
     mkdocs_gen_files.set_edit_path(full_doc_path, path)
 

diff --git a/streampipes-client-python/setup.py b/streampipes-client-python/setup.py
@@ -21,7 +21,7 @@
 import setuptools
 
 # Package meta-data.
-NAME = "streampipes-client"
+NAME = "streampipes"
 DESCRIPTION = "Python client for Apache StreamPipes"
 LONG_DESCRIPTION_CONTENT_TYPE = "text/markdown"
 URL = "https://github.com/apache/streampipes/"
@@ -74,7 +74,7 @@
 
 # Load the package's __version__.py module as a dictionary.
 about = {}
-with open(os.path.join(here, "streampipes_client", "__version__.py")) as f:
+with open(os.path.join(here, "streampipes", "__version__.py")) as f:
     exec(f.read(), about)
 
 # Where the magic happens:

diff --git a/...ent-python/streampipes_client/__init__.py → ...pes-client-python/streampipes/__init__.py b/...ent-python/streampipes_client/__init__.py → ...pes-client-python/streampipes/__init__.py
diff --git a/...-python/streampipes_client/__version__.py → ...-client-python/streampipes/__version__.py b/...-python/streampipes_client/__version__.py → ...-client-python/streampipes/__version__.py
diff --git a/...hon/streampipes_client/client/__init__.py → ...ent-python/streampipes/client/__init__.py b/...hon/streampipes_client/client/__init__.py → ...ent-python/streampipes/client/__init__.py