[DSX-632] Rename package from mlflow-client to mlflow-rest-client

Author: dolfinus

.github/workflows/test.yml

@@ -86,7 +86,7 @@ jobs:
       run: pip install -r requirements.txt -r requirements-test.txt -r requirements-dev.txt
 
     - name: Run pylint
-      run: pylint mlflow_client
+      run: pylint mlflow_rest_client
 
     - name: Build package
       run: |

.gitignore

@@ -20,6 +20,7 @@
 *~.nib
 .Python
 .buildpath
+*cache
 .cache
 .cache-main
 .classpath

.pre-commit-config.yaml

@@ -56,7 +56,7 @@ repos:
   rev: 5.10.1
   hooks:
   - id: isort
-    files: mlflow_client/.*
+    files: mlflow_rest_client/.*
   - id: isort
     files: tests/.*
 - repo: https://github.com/pre-commit/pygrep-hooks

CHANGELOG.rst

@@ -44,9 +44,12 @@ Changelog
 
     .. change::
         :tags: client, breaking
-        :tickets: DSX:545
+        :tickets: DSX:545, DSX:632
 
-        Rename ``MLflowApiClient`` to ``MLflowClient``
+        Rename library:
+
+            * ``mlflow-client`` -> ``mlflow-rest-client``
+            * ``MLflowApiClient`` -> ``MLflowRESTClient``
 
     .. change::
         :tags: general, feature
@@ -506,7 +509,7 @@ Changelog
         :tickets: SCRR:111
         :changeset: 77e7f798
 
-        ``mlflow-client`` package was created based on ``mlflow-python-client <https://github.com/amesar/mlflow-python-client>``__
+        ``mlflow-rest-client`` package was created based on ``mlflow-python-client <https://github.com/amesar/mlflow-python-client>``__
 
     .. change::
         :tags: artifact, feature

MANIFEST.in

@@ -1,4 +1,4 @@
-include LICENSE.txt README.rst requirements.txt requirements-test.txt requirements-dev.txt mlflow_client/VERSION
+include LICENSE.txt README.rst requirements.txt requirements-test.txt requirements-dev.txt mlflow_rest_client/VERSION
 recursive-exclude * __pycache__
 recursive-exclude * *.pyc
 recursive-exclude * *.pyo

README.rst

@@ -8,20 +8,20 @@ Python Client for MLflow
 
 .. |status| image:: https://www.repostatus.org/badges/latest/active.svg
     :target: https://www.repostatus.org/#active
-.. |PyPI| image:: https://badge.fury.io/py/mlflow-client.svg
-    :target: https://badge.fury.io/py/mlflow-client
-.. |PyPI License| image:: https://img.shields.io/pypi/l/mlflow-client.svg
-    :target: https://github.com/MobileTeleSystems/mlflow-client/blob/main/LICENSE.txt
-.. |PyPI Python Version| image:: https://img.shields.io/pypi/pyversions/mlflow-client.svg
-    :target: https://badge.fury.io/py/mlflow-client
-.. |ReadTheDocs| image:: https://img.shields.io/readthedocs/mlflow-client.svg
-    :target: https://mlflow-client.readthedocs.io
-.. |Build| image:: https://github.com/MobileTeleSystems/mlflow-client/workflows/Tests/badge.svg
-    :target: https://github.com/MobileTeleSystems/mlflow-client/actions
-.. |Coverage| image:: https://codecov.io/gh/MobileTeleSystems/mlflow-client/branch/main/graph/badge.svg
-    :target: https://codecov.io/gh/MobileTeleSystems/mlflow-client
-.. |pre-commit.ci| image:: https://results.pre-commit.ci/badge/github/MobileTeleSystems/mlflow-client/main.svg
-    :target: https://results.pre-commit.ci/latest/github/MobileTeleSystems/mlflow-client/main
+.. |PyPI| image:: https://badge.fury.io/py/mlflow-rest-client.svg
+    :target: https://badge.fury.io/py/mlflow-rest-client
+.. |PyPI License| image:: https://img.shields.io/pypi/l/mlflow-rest-client.svg
+    :target: https://github.com/MobileTeleSystems/mlflow-rest-client/blob/main/LICENSE.txt
+.. |PyPI Python Version| image:: https://img.shields.io/pypi/pyversions/mlflow-rest-client.svg
+    :target: https://badge.fury.io/py/mlflow-rest-client
+.. |ReadTheDocs| image:: https://img.shields.io/readthedocs/mlflow-rest-client.svg
+    :target: https://mlflow-rest-client.readthedocs.io
+.. |Build| image:: https://github.com/MobileTeleSystems/mlflow-rest-client/workflows/Tests/badge.svg
+    :target: https://github.com/MobileTeleSystems/mlflow-rest-client/actions
+.. |Coverage| image:: https://codecov.io/gh/MobileTeleSystems/mlflow-rest-client/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/MobileTeleSystems/mlflow-rest-client
+.. |pre-commit.ci| image:: https://results.pre-commit.ci/badge/github/MobileTeleSystems/mlflow-rest-client/main.svg
+    :target: https://results.pre-commit.ci/latest/github/MobileTeleSystems/mlflow-rest-client/main
 
 Python client for `MLflow <https://mlflow.org>`_ REST API.
 
@@ -51,7 +51,7 @@ Python client for `MLflow <https://mlflow.org>`_ REST API.
 Documentation
 -------------
 
-See https://mlflow-client.readthedocs.io/
+See https://mlflow-rest-client.readthedocs.io/
 
 .. contribution
 
@@ -78,9 +78,9 @@ Version example: ``2.0.0``
 
 .. code:: bash
 
-    pip install mlflow-client==2.0.0 # exact version
+    pip install mlflow-rest-client==2.0.0 # exact version
 
-    pip install mlflow-client # latest release
+    pip install mlflow-rest-client # latest release
 
 Development release
 ~~~~~~~~~~~~~~~~~~~~
@@ -89,9 +89,9 @@ Version example: ``2.0.0.dev5``
 
 .. code:: bash
 
-    pip install mlflow-client==2.0.0.dev5 # exact dev version
+    pip install mlflow-rest-client==2.0.0.dev5 # exact dev version
 
-    pip install --pre mlflow-client # latest dev version
+    pip install --pre mlflow-rest-client # latest dev version
 
 .. develop
 
@@ -101,9 +101,9 @@ Clone repo:
 
 .. code:: bash
 
-    git clone git@github.com:MobileTeleSystems/mlflow-client.git
+    git clone git@github.com:MobileTeleSystems/mlflow-rest-client.git
 
-    cd mlflow-client
+    cd mlflow-rest-client
 
 Install dependencies for development:
 
@@ -133,11 +133,11 @@ Make sure you have an `MLflow Tracking Server <https://mlflow.org/docs/latest/tr
 
 .. code:: python
 
-    from mlflow_client import MLflowClient
+    from mlflow_rest_client import MLflowRESTClient
 
-    client = MLflowClient("https://mlflow.domain", ignore_ssl_check=True)
+    client = MLflowRESTClient("https://mlflow.domain", ignore_ssl_check=True)
 
     experiment = client.get_or_create_experiment("experiment_name")
     run = client.create_run(experiment.id)
 
-See `sample.py <https://github.com/MobileTeleSystems/mlflow-client/blob/main/samples/sample.py>`_ for more examples.
+See `sample.py <https://github.com/MobileTeleSystems/mlflow-rest-client/blob/main/samples/sample.py>`_ for more examples.

docs/conf.py

@@ -28,7 +28,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "mlflow-client"
+project = "mlflow-rest-client"
 copyright = "2022, MTS (Mobile Telesystems)"
 author = "MTS DSX Team"
 
@@ -65,7 +65,7 @@
 # a list of builtin themes.
 #
 html_theme = "furo"
-html_title = f"mlflow-client {version}"
+html_title = f"mlflow-rest-client {version}"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -99,15 +99,15 @@
 changelog_hive_sections_from_tags = True
 
 changelog_render_ticket = {
-    "default": "https://github.com/MobileTeleSystems/mlflow-client/issues/%s",
+    "default": "https://github.com/MobileTeleSystems/mlflow-rest-client/issues/%s",
     "DSX": "https://jira.bd.msk.mts.ru/browse/DSX-%s",
     "SCRR": "https://jira.bd.msk.mts.ru/browse/SCRR-%s",
 }
 changelog_render_pullreq = {
-    "default": "https://github.com/MobileTeleSystems/mlflow-client/pull/%s",
+    "default": "https://github.com/MobileTeleSystems/mlflow-rest-client/pull/%s",
     "gitlab": "https://gitlab.services.mts.ru/bigdata/platform/dsx/mlflow-client/-/merge_requests/%s",
 }
-changelog_render_changeset = "https://github.com/MobileTeleSystems/mlflow-client/commit/%s"
+changelog_render_changeset = "https://github.com/MobileTeleSystems/mlflow-rest-client/commit/%s"
 
 language = "en"
 

docs/index.rst

@@ -18,13 +18,13 @@
     :name: mastertoc
     :hidden:
 
-    mlflow_client.client
-    mlflow_client.artifact
-    mlflow_client.experiment
-    mlflow_client.model
-    mlflow_client.page
-    mlflow_client.run
-    mlflow_client.tag
+    mlflow_rest_client.client
+    mlflow_rest_client.artifact
+    mlflow_rest_client.experiment
+    mlflow_rest_client.model
+    mlflow_rest_client.page
+    mlflow_rest_client.run
+    mlflow_rest_client.tag
 
 .. toctree::
     :maxdepth: 2
@@ -42,7 +42,7 @@
     :caption: Project Links
     :hidden:
 
-    Source Code <https://github.com/MobileTeleSystems/mlflow-client>
-    CI/CD <https://github.com/MobileTeleSystems/mlflow-client/actions>
-    Code Coverage <https://app.codecov.io/gh/MobileTeleSystems/mlflow-client>
-    Issue Tracker <https://github.com/MobileTeleSystems/mlflow-client/issues>
+    Source Code <https://github.com/MobileTeleSystems/mlflow-rest-client>
+    CI/CD <https://github.com/MobileTeleSystems/mlflow-rest-client/actions>
+    Code Coverage <https://app.codecov.io/gh/MobileTeleSystems/mlflow-rest-client>
+    Issue Tracker <https://github.com/MobileTeleSystems/mlflow-rest-client/issues>

docs/mlflow_client.artifact.rst docs/mlflow_rest_client.artifact.rstdocs/mlflow_client.artifact.rst renamed to docs/mlflow_rest_client.artifact.rst

@@ -1,12 +1,12 @@
 Artifact
 =================================================================
 
-.. currentmodule:: mlflow_client.artifact
+.. currentmodule:: mlflow_rest_client.artifact
 
 .. autosummary::
     :nosignatures:
 
     Artifact
 
-.. autoclass:: mlflow_client.artifact.Artifact
+.. autoclass:: mlflow_rest_client.artifact.Artifact
     :members:

docs/mlflow_client.client.rst docs/mlflow_rest_client.client.rstdocs/mlflow_client.client.rst renamed to docs/mlflow_rest_client.client.rst

@@ -3,14 +3,14 @@ MLflow API client
 
 Summary
 --------
-.. currentmodule:: mlflow_client.mlflow_client.MLflowClient
+.. currentmodule:: mlflow_rest_client.mlflow_rest_client.MLflowRESTClient
 
 Main class
 ^^^^^^^^^^^
 .. autosummary::
     :nosignatures:
 
-    mlflow_client.mlflow_client.MLflowClient
+    mlflow_rest_client.mlflow_rest_client.MLflowRESTClient
 
 Experiment
 ^^^^^^^^^^^
@@ -139,5 +139,5 @@ Model version
 
 Documentation
 --------------
-.. autoclass:: mlflow_client.mlflow_client.MLflowClient
+.. autoclass:: mlflow_rest_client.mlflow_rest_client.MLflowRESTClient
     :members: