Merge pull request #52 from martinRenou/rename_package

Rename package jupyter-bluetooth-manager

Author: HaudinFlorence

.copier-answers.yml

@@ -6,10 +6,10 @@ author_name: Florence Haudin
 has_binder: false
 has_settings: true
 kind: frontend
-labextension_name: bluetooth-manager
+labextension_name: jupyter-bluetooth-manager
 project_short_description: A JupyterLab extension to manage to connect to devices
     with web bluetooth.
-python_name: bluetooth_manager
+python_name: jupyter-bluetooth-manager
 repository: https://github.com/QuantStack/bluetooth-manager
 test: true
 

.github/workflows/build.yml

@@ -50,13 +50,13 @@ jobs:
 
         pip install build
         python -m build
-        pip uninstall -y "bluetooth_manager" jupyterlab
+        pip uninstall -y "jupyter-bluetooth-manager" jupyterlab
 
     - name: Upload extension packages
       uses: actions/upload-artifact@v4
       with:
         name: extension-artifacts
-        path: dist/bluetooth_manager*
+        path: dist/jupyter_bluetooth_manager*
         if-no-files-found: error
 
   test_isolated:
@@ -79,7 +79,7 @@ jobs:
         sudo rm -rf $(which node)
         sudo rm -rf $(which node)
 
-        pip install "jupyterlab>=4.0.0,<5" bluetooth_manager*.whl
+        pip install "jupyterlab>=4.0.0,<5" jupyter_bluetooth_manager*.whl
 
 
         jupyter labextension list
@@ -109,7 +109,7 @@ jobs:
     - name: Install the extension
       run: |
         set -eux
-        python -m pip install "jupyterlab>=4.0.0,<5" bluetooth_manager*.whl
+        python -m pip install "jupyterlab>=4.0.0,<5" jupyter_bluetooth_manager*.whl
 
     - name: Install dependencies
       working-directory: ui-tests

.gitignore

@@ -7,9 +7,9 @@ node_modules/
 *.egg-info/
 .ipynb_checkpoints
 *.tsbuildinfo
-bluetooth_manager/labextension
+jupyter_bluetooth_manager/labextension
 # Version file is handled by hatchling
-bluetooth_manager/_version.py
+jupyter_bluetooth_manager/_version.py
 
 # Integration tests
 ui-tests/test-results/

.prettierignore

@@ -3,4 +3,4 @@ node_modules
 **/lib
 **/package.json
 !/package.json
-bluetooth_manager
+jupyter_bluetooth_manager

README.md

@@ -1,4 +1,4 @@
-# bluetooth_manager
+# jupyter-bluetooth-manager
 
 A JupyterLab extension to manage to connect to devices with web bluetooth.
 
@@ -11,15 +11,15 @@ A JupyterLab extension to manage to connect to devices with web bluetooth.
 To install the extension, execute:
 
 ```bash
-pip install bluetooth_manager
+pip install jupyter-bluetooth-manager
 ```
 
 ## Uninstall
 
 To remove the extension, execute:
 
 ```bash
-pip uninstall bluetooth_manager
+pip uninstall jupyter-bluetooth-manager
 ```
 
 ## Contributing
@@ -34,7 +34,7 @@ The `jlpm` command is JupyterLab's pinned version of
 
 ```bash
 # Clone the repo to your local environment
-# Change directory to the bluetooth_manager directory
+# Change directory to the jupyter-bluetooth-manager directory
 # Install package in development mode
 pip install -e "."
 # Link your development version of the extension with JupyterLab
@@ -63,7 +63,7 @@ jupyter lab build --minimize=False
 ### Development uninstall
 
 ```bash
-pip uninstall bluetooth_manager
+pip uninstall jupyter-bluetooth-manager
 ```
 
 In development mode, you will also need to remove the symlink created by `jupyter labextension develop`

RELEASE.md

@@ -1,4 +1,4 @@
-# Making a new release of bluetooth_manager
+# Making a new release of jupyter-bluetooth-manager
 
 The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
 

examples/test-widget-with-ipykernel.ipynb

@@ -15,21 +15,21 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": null,
    "id": "762d552a-dafd-4b4b-9b0c-8b6612d2415b",
    "metadata": {
     "scrolled": true
    },
    "outputs": [],
    "source": [
-    "import asyncio    \n",
-    "from bluetooth_manager import MoveHubWidget,LedColor,Port, Sensor\n",
+    "import asyncio\n",
+    "from jupyter_bluetooth_manager import MoveHubWidget,LedColor,Port, Sensor\n",
     "from ipywidgets import Output\n",
     "from IPython.display import display\n",
     "\n",
     "# the robot's LED supports the following colors\n",
     "colors = [\n",
-    "    \n",
+    "\n",
     "    LedColor.pink,\n",
     "    LedColor.purple,\n",
     "    LedColor.blue,\n",
@@ -53,7 +53,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": null,
    "id": "aae633ad-bbb2-45c2-a1ff-5fab18146172",
    "metadata": {
     "scrolled": true
@@ -76,7 +76,7 @@
    ],
    "source": [
     "# number of concurrent \"lanes\"\n",
-    "n_lanes = 4 \n",
+    "n_lanes = 4\n",
     "widget = MoveHubWidget(n_lanes=n_lanes)\n",
     "output = Output()\n",
     "display(widget)"
@@ -179,13 +179,13 @@
     "d_forward  = 200\n",
     "d_rotate = 300\n",
     "output = Output()\n",
-    "async def main(lane,log, identifier):  \n",
+    "async def main(lane,log, identifier):\n",
     "    for i in range(4):\n",
     "        await lane.set_led_async(\"red\")\n",
     "        await lane.motor_angle_multi_async(angle=d_forward, power_a=speed,power_b=speed)\n",
     "        await lane.set_led_async(\"green\")\n",
     "        await lane.motor_angle_multi_async(angle=d_rotate, power_a=speed,power_b=-1.0*speed)\n",
-    "        \n",
+    "\n",
     "widget.run_async_program(main, output=output);\n",
     "output"
    ]

install.json

@@ -1,5 +1,5 @@
 {
   "packageManager": "python",
-  "packageName": "bluetooth_manager",
-  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package bluetooth_manager"
+  "packageName": "jupyter-bluetooth-manager",
+  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package jupyter-bluetooth-manager"
 }

bluetooth_manager/__init__.py jupyter_bluetooth_manager/__init__.pybluetooth_manager/__init__.py renamed to jupyter_bluetooth_manager/__init__.py

@@ -7,12 +7,12 @@
     # in editable mode with pip. It is highly recommended to install
     # the package from a stable release or in editable mode: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs
     import warnings
-    warnings.warn("Importing 'bluetooth_manager' outside a proper installation.")
+    warnings.warn("Importing 'jupyter_bluetooth_manager' outside a proper installation.")
     __version__ = "dev"
 
 
 def _jupyter_labextension_paths():
     return [{
         "src": "labextension",
-        "dest": "bluetooth-manager"
+        "dest": "jupyter-bluetooth-manager"
     }]