Change pypi package names to use 'MeasurementLink' (#178)

* Rename pypi packages to include MeasurementLink

* Update references to packages in examples

* Rename directory to include MeasurementLink

* Rename generator directory

* Update imports to use ni_measurementlink_service instead of ni_measurement_service

* Update generator directory in publish_nims script

* More usages of ni_measurement_generator

* Udpate contributing.md

* Update readme and contributing docs

* Remove measurement-services-python references after repo rename.

Author: dixonjoel

.github/ISSUE_TEMPLATE/bug_report.md

@@ -44,6 +44,6 @@ Search open/closed issues before submitting. Someone may have reported the same
 <!--- Include as many relevant details as possible about the environment you experienced the bug in -->
 
 * OS & Device: [e.g. macOS, Windows, Linux] on [Mac, PC]
-* `ni-measurement-service` version [e.g. 0.12.3]
+* `ni-measurementlink-service` version [e.g. 0.12.3]
 * MeasurementLink version [e.g. 23.0.0d123]
 * Python version [e.g. 3.9]

.github/workflows/PR.yml

@@ -34,17 +34,17 @@ jobs:
       - name: Lint the Code
         run: poetry run ni-python-styleguide lint
       - name: MyPy Static Analysis 
-        run:  poetry run mypy -p ni_measurement_service --show-error-codes -v
+        run:  poetry run mypy -p ni_measurementlink_service --show-error-codes -v
       - name: MyPy Static Analysis on examples 
         run:  poetry run mypy -p examples --show-error-codes -v
-      - name: MyPy Static Analysis ni_measurement_generator
-        run:  poetry run mypy -p ni_measurement_generator --show-error-codes -v
+      - name: MyPy Static Analysis ni_measurementlink_generator
+        run:  poetry run mypy -p ni_measurementlink_generator --show-error-codes -v
 
   checks-nimg:
     runs-on: ubuntu-latest
     defaults: # in theory this sets the working-dir for all steps in this job
       run:
-        working-directory: ./ni_measurement_generator
+        working-directory: ./ni_measurementlink_generator
     env:
       PYTHON_VERSION: 3.9
     steps:
@@ -57,7 +57,7 @@ jobs:
           poetry-version: ${{ env.POETRY_VERSION }}
       - name: Check for lock changes (generator)
         run: poetry lock --check
-        working-directory: ./ni_measurement_generator
+        working-directory: ./ni_measurementlink_generator
       - uses: actions/cache@v2
         with:
           path: ~/.cache/pypoetry/virtualenvs
@@ -91,10 +91,10 @@ jobs:
       - name: Install the Package (measurement service).
         run: poetry install -vvv
       - name: Run tests and Code coverage summary (measurement service).
-        run: poetry run pytest ./tests -v --cov=ni_measurement_service
+        run: poetry run pytest ./tests -v --cov=ni_measurementlink_service
       - name: Install the Package (generator).
         run: poetry install -vvv
-        working-directory: ./ni_measurement_generator
+        working-directory: ./ni_measurementlink_generator
       - name: Run tests and Code coverage summary (generator).
         run: poetry run pytest -v
-        working-directory: ./ni_measurement_generator
+        working-directory: ./ni_measurementlink_generator

.github/workflows/Publish_NIMS.yml

@@ -37,7 +37,7 @@ jobs:
 
       - name: Setup NIMG
         run: poetry install
-        working-directory: ./ni_measurement_generator
+        working-directory: ./ni_measurementlink_generator
 
       - name: Lint NIMS, NIMG, and examples
         run: poetry run ni-python-styleguide lint
@@ -54,7 +54,7 @@ jobs:
       - name: Update NIMG package version based on tag name.
         run: |
           poetry version ${{ steps.vars.outputs.tag }}
-        working-directory: ./ni_measurement_generator
+        working-directory: ./ni_measurementlink_generator
 
       - name: Update API Reference Documents(Generated using Sphinx)
         run: |
@@ -89,7 +89,7 @@ jobs:
         if: ${{ startsWith(github.event.release.target_commitish, 'main') }}
         run: |
           poetry publish --build --username __token__ --password ${{ secrets.PYPI_TOKEN }}
-        working-directory: ./ni_measurement_generator
+        working-directory: ./ni_measurementlink_generator
 
       - uses: actions/upload-artifact@v3
         with:

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 Contributions to MeasurementLink Support for Python are welcome from all!
 
 MeasurementLink Support for Python is managed via [git](https://git-scm.com), with the canonical upstream
-repository hosted on [GitHub](https://github.com/ni/measurement-services-python/). The repo contains templates and examples for developing MeasurementLink services in Python.
+repository hosted on [GitHub](https://github.com/ni/measurementlink-python/). The repo contains templates and examples for developing MeasurementLink services in Python.
 
 MeasurementLink Support for Python follows a pull-request model for development.  If you wish to
 contribute, you will need to create a GitHub account, fork this project, push a
@@ -33,7 +33,7 @@ See [GitHub's official documentation](https://help.github.com/articles/using-pul
 Clone the repo, this will pull the MeasurementLink Support for Python components and related components.
 
 ```cmd
-git clone https://github.com/ni/measurement-services-python.git
+git clone https://github.com/ni/measurementlink-python.git
 ```
 
 ## Initializing the repo with .venv
@@ -52,7 +52,7 @@ poetry init
 
 # Adding dependencies
 
-Add dependency package for `ni_measurement_service`  using [poetry add](https://python-poetry.org/docs/cli/#add) command.
+Add dependency package for `ni_measurementlink_service`  using [poetry add](https://python-poetry.org/docs/cli/#add) command.
 
 ```cmd
 poetry add <name_of_dependency>:<version>
@@ -66,7 +66,7 @@ poetry add -D <name_of_dev_dependency>:<version>
 
 # Updating gRPC stubs when a .proto file is modified
 
-The `ni_measurement_service\_internal\stubs` directory contains the auto-generated python files based on MeasurementLink protobuf (.proto) files. The file needs to be replaced whenever there is a change to these .proto files:
+The `ni_measurementlink_service\_internal\stubs` directory contains the auto-generated python files based on MeasurementLink protobuf (.proto) files. The file needs to be replaced whenever there is a change to these .proto files:
 
 - ni/measurementlink/pin_map_context.proto
 - ni/measurementlink/discovery/v1/discovery_service.proto
@@ -76,7 +76,7 @@ The `ni_measurement_service\_internal\stubs` directory contains the auto-generat
 - nidevice_grpc/README.md
 - nidevice_grpc/session.proto
 
-The latest .proto files are available in [Azure Repo](https://dev.azure.com/ni/DevCentral/_git/ASW?path=/Source/Protos). From the Azure Repo manually download and overwrite the proto files under the `ni_measurement_service\_internal\stubs\proto` folder.
+The latest .proto files are available in [Azure Repo](https://dev.azure.com/ni/DevCentral/_git/ASW?path=/Source/Protos). From the Azure Repo manually download and overwrite the proto files under the `ni_measurementlink_service\_internal\stubs\proto` folder.
 
 Run `poetry run python scripts/generate_grpc_stubs.py`. This generates the required *.py file for the listed proto files. The required `grpcio-tools` package is already added as a development dependency in pyproject.toml.
 
@@ -96,21 +96,21 @@ poetry run ni-python-styleguide fix
 poetry build
 ```
 
-Running this command from the repo's root directory will generate the tar.gz file and .whl file of ni_measurement_service package to the `dist` directory.
+Running this command from the repo's root directory will generate the tar.gz file and .whl file of ni_measurementlink_service package to the `dist` directory.
 
 # Testing
 
-`ni-measurement-service` includes tests under the directory `tests\` that exercises the python and grpc modules. The GitHub CI run these tests for PRs targeting the main branch. It is recommended that during development you run the tests locally before creating a PR.
+`ni-measurementlink-service` includes tests under the directory `tests\` that exercises the python and grpc modules. The GitHub CI run these tests for PRs targeting the main branch. It is recommended that during development you run the tests locally before creating a PR.
 
-In order to run the `ni-measurement-service` tests locally:
+In order to run the `ni-measurementlink-service` tests locally:
 
 ## Using Command Line
 
 1. Install production dependencies and development dependencies into a venv by running `poetry install`.
 2. Execute the command `poetry run pytest -v` to run the tests, from the repo's root directory.
 
     ``` ps
-    (.venv) PS D:\TAF\measurement-services-python> poetry run pytest -v
+    (.venv) PS D:\TAF\measurementlink-python> poetry run pytest -v
     ```
 
 ## Using VS code Test Explorer extension(UI)
@@ -121,8 +121,8 @@ Install and configure the `Python Test Explorer for Visual Studio Code` extensio
 
 - Install the required dependency by running `poetry install`
 - Activate the virtual environment if not already activated : `.venv\Scripts\activate`
-- Run the command `pytest --cov=ni_measurement_service`, from the repo's root directory **to get the summary of test coverage** in the console.
-- Run the command `pytest --cov-report html:cov_html --cov=ni_measurement_service`, from the repo's root directory **to generate detailed HTML based coverage report**. Upon running, the coverage reports will be created under `<repo_root>\cov_html` directory.
+- Run the command `pytest --cov=ni_measurementlink_service`, from the repo's root directory **to get the summary of test coverage** in the console.
+- Run the command `pytest --cov-report html:cov_html --cov=ni_measurementlink_service`, from the repo's root directory **to generate detailed HTML based coverage report**. Upon running, the coverage reports will be created under `<repo_root>\cov_html` directory.
 
 # Developer Certificate of Origin (DCO)
 
@@ -154,5 +154,5 @@ Install and configure the `Python Test Explorer for Visual Studio Code` extensio
 
 (taken from [developercertificate.org](https://developercertificate.org/))
 
-See [LICENSE](https://github.com/ni/measurement-services-python/blob/master/LICENSE)
+See [LICENSE](https://github.com/ni/measurementlink-python/blob/master/LICENSE)
 for details about how MeasurementLink Support for Python is licensed.

README.md

@@ -18,13 +18,13 @@
   - [Appendix: Managing Measurement as Python Package(Project)](#appendix-managing-measurement-as-python-packageproject)
     - [Create and Manage Python Measurement Package using poetry](#create-and-manage-python-measurement-package-using-poetry)
     - [Create and Manage Python Measurement Package using venv](#create-and-manage-python-measurement-package-using-venv)
-    - [Create and Manage Python Measurement Package by directly installing `ni-measurement-service` as a system-level package](#create-and-manage-python-measurement-package-by-directly-installing-ni-measurement-service-as-a-system-level-package)
+    - [Create and Manage Python Measurement Package by directly installing `ni-measurementlink-service` as a system-level package](#create-and-manage-python-measurement-package-by-directly-installing-ni-measurementlink-service-as-a-system-level-package)
 
 ---
 
 ## Introduction
 
-MeasurementLink Support for Python (`ni-measurement-service`) is a python framework that enables measurement developers to quickly create python measurements and run them as a service (gRPC).
+MeasurementLink Support for Python (`ni-measurementlink-service`) is a python framework that enables measurement developers to quickly create python measurements and run them as a service (gRPC).
 
 ---
 
@@ -60,10 +60,10 @@ The example measurements shared are *poetry-based* projects. Follow the below st
 
     ``` cmd
     cd <path_of_example_measurement>
-    REM Example: cd "..\measurement-services-python\examples\dc_measurement"
+    REM Example: cd "..\measurementlink-python\examples\dc_measurement"
     ```
 
-3. Run `poetry install`. This command creates/updates the .venv and installs all the dependencies(including `ni-measurement-service` package) needed for the Example into `.venv`
+3. Run `poetry install`. This command creates/updates the .venv and installs all the dependencies(including `ni-measurementlink-service` package) needed for the Example into `.venv`
 
     ``` cmd
     poetry install
@@ -92,41 +92,41 @@ Make sure the system has the recommended python version is installed. Install Me
 
 ``` cmd
 REM Activate the required virtual environment if any.
-pip install ni-measurement-service
+pip install ni-measurementlink-service
 ```
 
 Check if you have installed the expected version of MeasurementLink Support for Python installed by running the below command:
 
 ```cmd
-pip show ni-measurement-service
+pip show ni-measurementlink-service
 ```
 
 ### Developing a minimal python measurement
 
-1. Install the `ni-measurement-generator` package.
+1. Install the `ni-measurementlink-generator` package.
 
 ``` cmd
 REM Activate the required virtual environment if any.
-pip install ni-measurement-generator
+pip install ni-measurementlink-generator
 ```
 
-2. Run the `ni-measurement-generator` tool. Use command line arguments to specify the `display-name` and optionally the `version`, `measurement-type`, and `product-type`.
+2. Run the `ni-measurementlink-generator` tool. Use command line arguments to specify the `display-name` and optionally the `version`, `measurement-type`, and `product-type`.
 
-    1. Running `ni-measurement-generator` without optional arguments:
+    1. Running `ni-measurementlink-generator` without optional arguments:
 
-    `ni-measurement-generator SampleMeasurement`
+    `ni-measurementlink-generator SampleMeasurement`
 
     'SampleMeasurement' is the display name of your measurement service. Without the optional arguments,
     the other arguments are generated for you based on the display name.
 
-    2. Running `ni-measurement-generator` with optional arguments for `measurement-version`, `ui-file`,
+    2. Running `ni-measurementlink-generator` with optional arguments for `measurement-version`, `ui-file`,
     `service-class`, and `description-url`:
 
-    `ni-measurement-generator SampleMeasurement --measurement-version 0.1.0.0 --ui-file MeasurementUI.measui --service-class SampleMeasurement_Python --description-url https://www.example.com/SampleMeasurement.html`
+    `ni-measurementlink-generator SampleMeasurement --measurement-version 0.1.0.0 --ui-file MeasurementUI.measui --service-class SampleMeasurement_Python --description-url https://www.example.com/SampleMeasurement.html`
 
-    3. Running `ni-measurement-generator` with optional argument for `directory-out`
+    3. Running `ni-measurementlink-generator` with optional argument for `directory-out`
 
-    `ni-measurement-generator SampleMeasurement --directory-out <new_path_for_created_files>`
+    `ni-measurementlink-generator SampleMeasurement --directory-out <new_path_for_created_files>`
 
     If no output directory is specified, the files will
     be placed in a new folder under the current directory
@@ -238,7 +238,7 @@ pyinstaller --onefile --console --add-data "<path_of_the_UI_File>;." --paths .ve
 
 ## API References
 
-[Click here](https://ni.github.io/measurement-services-python/) to view the API reference documentation.
+[Click here](https://ni.github.io/measurementlink-python/) to view the API reference documentation.
 
 ## Appendix: Managing Measurement as Python Package(Project)
 
@@ -265,7 +265,7 @@ Note: Once we have the template support for Python measurement, the approach to
 
     2. Install the `poetry` using the installation steps given in <https://python-poetry.org/docs/#installation>.
 
-2. Create a new python project and add `ni-measurement-service` as a dependency to the project.
+2. Create a new python project and add `ni-measurementlink-service` as a dependency to the project.
 
     1. Open a command prompt, and change the working directory to the directory of your choice where you want to create the project.
 
@@ -279,11 +279,11 @@ Note: Once we have the template support for Python measurement, the approach to
         poetry new <name_of_the_project>
         ```
 
-    3. Add the `ni-measurement-service` package as a dependency using the [poetry add command](https://python-poetry.org/docs/cli/#add).
+    3. Add the `ni-measurementlink-service` package as a dependency using the [poetry add command](https://python-poetry.org/docs/cli/#add).
 
         ``` cmd
         cd <name_of_the_project>
-        poetry add ni-measurement-service
+        poetry add ni-measurementlink-service
         ```
 
     4. The virtual environment will be auto-created by poetry.
@@ -322,10 +322,10 @@ For detailed info on managing projects using poetry [refer to the official docum
     python -m pip install -U pip
     ```
 
-5. Install the `ni-measurement-service` package into the virtual environment.
+5. Install the `ni-measurementlink-service` package into the virtual environment.
 
     ``` cmd
-    pip install ni-measurement-service
+    pip install ni-measurementlink-service
     ```
 
 6. Create measurement modules as described in ["Developing a minimal python measurement"](#developing-a-minimal-python-measurement)
@@ -337,14 +337,14 @@ For detailed info on managing projects using poetry [refer to the official docum
 
 For detailed info on managing projects with a virtual environment [refer to the official documentation](https://docs.python.org/3/tutorial/venv.html).
 
-### Create and Manage Python Measurement Package by directly installing `ni-measurement-service` as a system-level package
+### Create and Manage Python Measurement Package by directly installing `ni-measurementlink-service` as a system-level package
 
-Measurement developers can also install `ni-measurement-service` as a system package if necessary.
+Measurement developers can also install `ni-measurementlink-service` as a system package if necessary.
 
-1. Install the `ni-measurement-service` package from the command prompt
+1. Install the `ni-measurementlink-service` package from the command prompt
 
     ``` cmd
-    pip install ni-measurement-service
+    pip install ni-measurementlink-service
     ```
 
 2. Create measurement modules as described in ["Developing a minimal python measurement"](#developing-a-minimal-python-measurement)

_docs_source/conf.py

@@ -44,7 +44,7 @@
 # tell autoapi to doc the public options
 autoapi_options = list(autoapi.extension._DEFAULT_OPTIONS)
 autoapi_options.remove("private-members")  # note: remove this to include "_" members in docs
-autoapi_dirs = [root_path / "ni_measurement_service"]
+autoapi_dirs = [root_path / "ni_measurementlink_service"]
 autoapi_type = "python"
 autodoc_typehints = "none"
 

examples/nidaqmx_analog_input/measurement.py

@@ -7,7 +7,7 @@
 import click
 import nidaqmx
 
-import ni_measurement_service as nims
+import ni_measurementlink_service as nims
 
 measurement_info = nims.MeasurementInfo(
     display_name="NI-DAQmx Analog Input (Py)",

examples/nidaqmx_analog_input/pyproject.toml

@@ -7,7 +7,7 @@ authors = ["National Instruments"]
 [tool.poetry.dependencies]
 python = "^3.8"
 nidaqmx = ">=0.6.3"
-ni-measurement-service = "*"
+ni-measurementlink-service = "*"
 click = ">=7.1.2"
 
 [tool.poetry.dev-dependencies]

examples/nidcpower_source_dc_voltage/_helpers.py

@@ -6,13 +6,13 @@
 
 import grpc
 
-from ni_measurement_service import session_management
-from ni_measurement_service._internal.discovery_client import DiscoveryClient
-from ni_measurement_service._internal.stubs.ni.measurementlink.pinmap.v1 import (
+from ni_measurementlink_service import session_management
+from ni_measurementlink_service._internal.discovery_client import DiscoveryClient
+from ni_measurementlink_service._internal.stubs.ni.measurementlink.pinmap.v1 import (
     pin_map_service_pb2,
     pin_map_service_pb2_grpc,
 )
-from ni_measurement_service.measurement.service import GrpcChannelPool
+from ni_measurementlink_service.measurement.service import GrpcChannelPool
 
 
 class ServiceOptions(NamedTuple):

examples/nidcpower_source_dc_voltage/measurement.py

@@ -13,7 +13,7 @@
 import nidcpower
 from _helpers import ServiceOptions
 
-import ni_measurement_service as nims
+import ni_measurementlink_service as nims
 
 
 NIDCPOWER_WAIT_FOR_EVENT_TIMEOUT_ERROR_CODE = -1074116059