Rename references (#47)

* Update refs from python_wsdb to mapepire_python Signed-off-by: Irfan Sharif <[email protected]> * Update mapepire_python imports to use relative paths Signed-off-by: Irfan Sharif <[email protected]> * Update remaining python_wsdb refs to mapepire_python Signed-off-by: Irfan Sharif <[email protected]> * Rename refs from python-wsdb to mapepire-python Signed-off-by: Irfan Sharif <[email protected]> * Formatting and linting Signed-off-by: Irfan Sharif <[email protected]> * Fix import error Signed-off-by: Irfan Sharif <[email protected]> * Update CHANGELOG Signed-off-by: Irfan Sharif <[email protected]> --------- Signed-off-by: Irfan Sharif <[email protected]> Co-authored-by: Irfan Sharif <[email protected]>
Mapepire-IBMi · Aug 19, 2024 · 5d43b53 · 5d43b53
1 parent 4243cbe
commit 5d43b53
Show file tree

Hide file tree

Showing 24 changed files with 81 additions and 74 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -6,10 +6,10 @@ Thanks for considering contributing! Please read this document to learn the vari
 
 ### Did you find a bug?
 
-First, do [a quick search](https://github.com/ajshedivy/python-wsdb/issues) to see whether your issue has already been reported.
+First, do [a quick search](https://github.com/Mapepire-IBMi/mapepire-python/issues) to see whether your issue has already been reported.
 If your issue has already been reported, please comment on the existing issue.
 
-Otherwise, open [a new GitHub issue](https://github.com/ajshedivy/python-wsdb/issues).  Be sure to include a clear title
+Otherwise, open [a new GitHub issue](https://github.com/Mapepire-IBMi/mapepire-python/issues).  Be sure to include a clear title
 and description.  The description should include as much relevant information as possible.  The description should
 explain how to reproduce the erroneous behavior as well as the behavior you expect to see.  Ideally you would include a
 code sample or an executable test case demonstrating the expected behavior.
@@ -21,7 +21,7 @@ We use GitHub issues to track feature requests. Before you create a feature requ
 * Make sure you have a clear idea of the enhancement you would like. If you have a vague idea, consider discussing
 it first on a GitHub issue.
 * Check the documentation to make sure your feature does not already exist.
-* Do [a quick search](https://github.com/ajshedivy/python-wsdb/issues) to see whether your feature has already been suggested.
+* Do [a quick search](https://github.com/Mapepire-IBMi/mapepire-python/issues) to see whether your feature has already been suggested.
 
 When creating your request, please:
 
@@ -41,31 +41,31 @@ When you're ready to contribute code to address an open issue, please follow the
 
     Then clone your fork locally with
 
-        git clone https://github.com/USERNAME/python-wsdb.git
+        git clone https://github.com/USERNAME/mapepire-python.git
 
     or 
 
-        git clone [email protected]:USERNAME/python-wsdb.git
+        git clone [email protected]:USERNAME/mapepire-python.git
 
-    At this point the local clone of your fork only knows that it came from *your* repo, github.com/USERNAME/python-wsdb.git, but doesn't know anything the *main* repo, [https://github.com/ajshedivy/python-wsdb.git](https://github.com/ajshedivy/python-wsdb). You can see this by running
+    At this point the local clone of your fork only knows that it came from *your* repo, github.com/USERNAME/mapepire-python.git, but doesn't know anything the *main* repo, [https://github.com/Mapepire-IBMi/mapepire-python](https://github.com/Mapepire-IBMi/mapepire-python). You can see this by running
 
         git remote -v
 
     which will output something like this:
 
-        origin https://github.com/USERNAME/python-wsdb.git (fetch)
-        origin https://github.com/USERNAME/python-wsdb.git (push)
+        origin https://github.com/USERNAME/mapepire-python.git (fetch)
+        origin https://github.com/USERNAME/mapepire-python.git (push)
 
-    This means that your local clone can only track changes from your fork, but not from the main repo, and so you won't be able to keep your fork up-to-date with the main repo over time. Therefore you'll need to add another "remote" to your clone that points to [https://github.com/ajshedivy/python-wsdb.git](https://github.com/ajshedivy/python-wsdb). To do this, run the following:
+    This means that your local clone can only track changes from your fork, but not from the main repo, and so you won't be able to keep your fork up-to-date with the main repo over time. Therefore you'll need to add another "remote" to your clone that points to [https://github.com/Mapepire-IBMi/mapepire-python](https://github.com/Mapepire-IBMi/mapepire-python). To do this, run the following:
 
-        git remote add upstream https://github.com/ajshedivy/python-wsdb.git
+        git remote add upstream https://github.com/Mapepire-IBMi/mapepire-python
 
     Now if you do `git remote -v` again, you'll see
 
-        origin https://github.com/USERNAME/python-wsdb.git (fetch)
-        origin https://github.com/USERNAME/python-wsdb.git (push)
-        upstream https://github.com/ajshedivy/python-wsdb.git (fetch)
-        upstream https://github.com/ajshedivy/python-wsdb.git (push)
+        origin https://github.com/USERNAME/mapepire-python.git (fetch)
+        origin https://github.com/USERNAME/mapepire-python.git (push)
+        upstream https://github.com/Mapepire-IBMi/mapepire-python (fetch)
+        upstream https://github.com/Mapepire-IBMi/mapepire-python (push)
 
     Finally, you'll need to create a Python 3 virtual environment suitable for working on this project. There a number of tools out there that making working with virtual environments easier.
     The most direct way is with the [`venv` module](https://docs.python.org/3.7/library/venv.html) in the standard library, but if you're new to Python or you don't already have a recent Python 3 version installed on your machine,
@@ -77,8 +77,8 @@ When you're ready to contribute code to address an open issue, please follow the
 
     Then you can create and activate a new Python environment by running:
 
-        conda create -n python-wsdb python=3.9
-        conda activate python-wsdb
+        conda create -n mapepire-python python=3.9
+        conda activate mapepire-python
 
     Once your virtual environment is activated, you can install your local clone in "editable mode" with
 
@@ -93,7 +93,7 @@ When you're ready to contribute code to address an open issue, please follow the
 
     <details><summary>Expand details 👇</summary><br/>
 
-    Once you've added an "upstream" remote pointing to [https://github.com/allenai/python-package-temlate.git](https://github.com/ajshedivy/python-wsdb), keeping your fork up-to-date is easy:
+    Once you've added an "upstream" remote pointing to [https://github.com/allenai/python-package-temlate.git](https://github.com/Mapepire-IBMi/mapepire-python), keeping your fork up-to-date is easy:
 
         git checkout main  # if not already on main
         git pull --rebase upstream main
@@ -119,7 +119,7 @@ When you're ready to contribute code to address an open issue, please follow the
 
     <details><summary>Expand details 👇</summary><br/>
 
-    Our continuous integration (CI) testing runs [a number of checks](https://github.com/ajshedivy/python-wsdb/actions) for each pull request on [GitHub Actions](https://github.com/features/actions). You can run most of these tests locally, which is something you should do *before* opening a PR to help speed up the review process and make it easier for us.
+    Our continuous integration (CI) testing runs [a number of checks](https://github.com/Mapepire-IBMi/mapepire-python/actions) for each pull request on [GitHub Actions](https://github.com/features/actions). You can run most of these tests locally, which is something you should do *before* opening a PR to help speed up the review process and make it easier for us.
 
     First, you should run [`isort`](https://github.com/PyCQA/isort) and [`black`](https://github.com/psf/black) to make sure you code is formatted consistently.
     Many IDEs support code formatters as plugins, so you may be able to setup isort and black to run automatically everytime you save.
@@ -137,9 +137,9 @@ When you're ready to contribute code to address an open issue, please follow the
 
         mypy .
 
-    We also strive to maintain high test coverage, so most contributions should include additions to [the unit tests](https://github.com/ajshedivy/python-wsdb/tree/main/tests). These tests are run with [`pytest`](https://docs.pytest.org/en/latest/), which you can use to locally run any test modules that you've added or changed.
+    We also strive to maintain high test coverage, so most contributions should include additions to [the unit tests](https://github.com/Mapepire-IBMi/mapepire-python/tree/main/tests). These tests are run with [`pytest`](https://docs.pytest.org/en/latest/), which you can use to locally run any test modules that you've added or changed.
 
-    For example, if you've fixed a bug in `python_wsdb/a/b.py`, you can run the tests specific to that module with
+    For example, if you've fixed a bug in `mapepire_python/a/b.py`, you can run the tests specific to that module with
 
         pytest -v tests/a/b_test.py
 
@@ -152,9 +152,9 @@ When you're ready to contribute code to address an open issue, please follow the
 
     If the build fails, it's most likely due to small formatting issues. If the error message isn't clear, feel free to comment on this in your pull request.
 
-    And finally, please update the [CHANGELOG](https://github.com/ajshedivy/python-wsdb/blob/main/CHANGELOG.md) with notes on your contribution in the "Unreleased" section at the top.
+    And finally, please update the [CHANGELOG](https://github.com/Mapepire-IBMi/mapepire-python/blob/main/CHANGELOG.md) with notes on your contribution in the "Unreleased" section at the top.
 
-    After all of the above checks have passed, you can now open [a new GitHub pull request](https://github.com/ajshedivy/python-wsdb/pulls).
+    After all of the above checks have passed, you can now open [a new GitHub pull request](https://github.com/Mapepire-IBMi/mapepire-python/pulls).
     Make sure you have a clear description of the problem and the solution, and include a link to relevant issues.
 
     We look forward to reviewing your PR!

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -6,7 +6,7 @@ body:
 - type: markdown
   attributes:
     value: >
-      #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/ajshedivy/python-wsdb/issues?q=is%3Aissue+sort%3Acreated-desc+).
+      #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/Mapepire-IBMi/mapepire-python/issues?q=is%3Aissue+sort%3Acreated-desc+).
 - type: textarea
   attributes:
     label: 🐛 Describe the bug
@@ -17,7 +17,7 @@ body:
 
       ```python
       # All necessary imports at the beginning
-      import python_wsdb
+      import mapepire_python
 
       # A succinct reproducing example trimmed down to the essential parts:
       assert False is True, "Oh no!"

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -11,9 +11,9 @@ Changes proposed in this pull request:
 
 <!-- Please complete this checklist BEFORE submitting your PR to speed along the review process. -->
 - [ ] Change the base branch to `dev` if it is not already.
-- [ ] I've read and followed all steps in the [Making a pull request](https://github.com/ajshedivy/python-wsdb/blob/main/.github/CONTRIBUTING.md#making-a-pull-request)
+- [ ] I've read and followed all steps in the [Making a pull request](https://github.com/Mapepire-IBMi/mapepire-python/blob/main/.github/CONTRIBUTING.md#making-a-pull-request)
     section of the `CONTRIBUTING` docs.
 - [ ] I've updated or added any relevant docstrings following the syntax described in the
-    [Writing docstrings](https://github.com/ajshedivy/python-wsdb/blob/main/.github/CONTRIBUTING.md#writing-docstrings) section of the `CONTRIBUTING` docs.
+    [Writing docstrings](https://github.com/Mapepire-IBMi/mapepire-python/blob/main/.github/CONTRIBUTING.md#writing-docstrings) section of the `CONTRIBUTING` docs.
 - [ ] If this PR fixes a bug, I've added a test that will fail without my fix.
 - [ ] If this PR adds a new feature, I've added tests that sufficiently cover my new functionality.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,15 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [v0.1.4] - 2025-08-09
+Rename references from python_wsdb and python-wsdb to mapepire_python and mapepire-python
+
 ## [v0.1.3] - 2025-08-02
 Add workflow to run test suite on PR's
 Update requirements-dev.txt to include isort, black, ruff, mypy
 
-## [v0.1.2](https://github.com/ajshedivy/python-wsdb/releases/tag/v0.1.2) - 2024-04-22
+## [v0.1.2](https://github.com/Mapepire-IBMi/mapepire-python/releases/tag/v0.1.2) - 2024-04-22
 
-## [v0.1.1](https://github.com/ajshedivy/python-wsdb/releases/tag/v0.1.1) - 2024-04-19
+## [v0.1.1](https://github.com/Mapepire-IBMi/mapepire-python/releases/tag/v0.1.1) - 2024-04-19
 
-## [v0.1.0](https://github.com/ajshedivy/python-wsdb/releases/tag/v0.1.0) - 2024-04-19
+## [v0.1.0](https://github.com/Mapepire-IBMi/mapepire-python/releases/tag/v0.1.0) - 2024-04-19
 Add initial release
 
 ## [0.1.2] 

diff --git a/Makefile b/Makefile
@@ -1,15 +1,15 @@
 .PHONY : docs
 docs :
 	rm -rf docs/build/
-	sphinx-autobuild -b html --watch python_wsdb/ docs/source/ docs/build/
+	sphinx-autobuild -b html --watch mapepire_python/ docs/source/ docs/build/
 
 .PHONY : run-checks
 run-checks :
 	isort --check .
 	black --check .
 	ruff check .
 	mypy .
-	CUDA_VISIBLE_DEVICES='' pytest -v --color=yes --doctest-modules tests/ python_wsdb/
+	CUDA_VISIBLE_DEVICES='' pytest -v --color=yes --doctest-modules tests/ mapepire_python/
 
 .PHONY : build
 build :

diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
-# python-wsdb
+# mapepire-python
 <div align="center">
-<a href="https://github.com/ajshedivy/python-wsdb/actions">
-    <img alt="CI" src="https://img.shields.io/github/actions/workflow/status/ajshedivy/python-wsdb/main.yml">
+<a href="https://github.com/Mapepire-IBMi/mapepire-python/actions">
+    <img alt="CI" src="https://img.shields.io/github/actions/workflow/status/Mapepire-IBMi/mapepire-python/main.yml">
 </a>
 <a href="https://pypi.org/project/python-wsdb/">
     <img alt="PyPI" src="https://img.shields.io/pypi/v/python-wsdb">
 </a>
-<a href="https://github.com/ajshedivy/python-wsdb/blob/main/LICENSE">
+<a href="https://github.com/Mapepire-IBMi/mapepire-python/blob/main/LICENSE">
     <img alt="License" src="https://img.shields.io/github/license/allenai/tango.svg?color=blue&cachedrop">
 </a>
 <br/>
@@ -40,15 +40,15 @@
 
 ![alt text](images/image-1.png)
 
-`python-wsdb` is a Python client implementation that leverages the [CodeFori Server Component](https://github.com/ThePrez/CodeForIBMiServer). 
+`mapepire-python` is a Python client implementation that leverages the [CodeFori Server Component](https://github.com/ThePrez/CodeForIBMiServer). 
 
 ## Setup
 
-`python-wsdb` requires Python 3.9 or later.
+`mapepire-python` requires Python 3.9 or later.
 
 ### Install with `pip`
 
-`python-wsdb` is available on [PyPi](https://pypi.org/project/python-wsdb/). Just Run
+`mapepire-python` is available on [PyPi](https://pypi.org/project/python-wsdb/). Just Run
 
 ```bash
 pip install python-wsdb
@@ -61,8 +61,8 @@ pip install python-wsdb
 The following script sets up a `DaemonServer` object that will be used to connect with the Server Component. Then a single `SQLJob` is created to facilitate the connection from the client side. 
 
 ```python
-from python_wsdb.client.sql_job import SQLJob
-from python_wsdb.types import DaemonServer
+from mapepire_python.client.sql_job import SQLJob
+from mapepire_python.types import DaemonServer
 
 creds = DaemonServer(
     host="localhost",

diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
@@ -2,7 +2,7 @@
 
 ## Steps
 
-1. Update the version in `python_wsdb/version.py`.
+1. Update the version in `mapepire_python/version.py`.
 
 3. Run the release script:
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -18,11 +18,11 @@
 
 sys.path.insert(0, os.path.abspath("../../"))
 
-from python_wsdb import VERSION, VERSION_SHORT  # noqa: E402
+from mapepire_python.version import VERSION, VERSION_SHORT  # noqa: E402
 
 # -- Project information -----------------------------------------------------
 
-project = "python-wsdb"
+project = "mapepire-python"
 copyright = f"{datetime.today().year}, Allen Institute for Artificial Intelligence"
 author = "Allen Institute for Artificial Intelligence"
 version = VERSION_SHORT
@@ -82,7 +82,7 @@
 #
 html_theme = "furo"
 
-html_title = f"python-wsdb v{VERSION}"
+html_title = f"mapepire-python v{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,
@@ -97,7 +97,7 @@
     "footer_icons": [
         {
             "name": "GitHub",
-            "url": "https://github.com/ajshedivy/python-wsdb",
+            "url": "https://github.com/Mapepire-IBMi/mapepire-python",
             "html": """
                 <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
                     <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -1,4 +1,4 @@
-# **python-wsdb**
+# **mapepire-python**
 
 ```{toctree}
 :maxdepth: 2
@@ -15,8 +15,8 @@ overview
 
 CHANGELOG
 CONTRIBUTING
-License <https://raw.githubusercontent.com/allenai/python-wsdb/main/LICENSE>
-GitHub Repository <https://github.com/ajshedivy/python-wsdb>
+License <https://raw.githubusercontent.com/Mapepire-IBMi/mapepire-python/main/LICENSE>
+GitHub Repository <https://github.com/Mapepire-IBMi/mapepire-python>
 ```
 
 ## Indices and tables

diff --git a/docs/source/installation.md b/docs/source/installation.md
@@ -1,23 +1,23 @@
 Installation
 ============
 
-**python-wsdb** supports Python >= 3.8.
+**mapepire-python** supports Python >= 3.8.
 
 ## Installing with `pip`
 
-**python-wsdb** is available [on PyPI](https://pypi.org/project/python-wsdb/). Just run
+**mapepire-python** is available [on PyPI](https://pypi.org/project/python-wsdb/). Just run
 
 ```bash
 pip install python-wsdb
 ```
 
 ## Installing from source
 
-To install **python-wsdb** from source, first clone [the repository](https://github.com/ajshedivy/python-wsdb):
+To install **mapepire-python** from source, first clone [the repository](https://github.com/Mapepire-IBMi/mapepire-python):
 
 ```bash
-git clone https://github.com/ajshedivy/python-wsdb.git
-cd python-wsdb
+git clone https://github.com/Mapepire-IBMi/mapepire-python
+cd mapepire-python
 ```
 
 Then run

diff --git a/examples/simple-example.ipynb b/examples/simple-example.ipynb
@@ -6,11 +6,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from python_wsdb.client.sql_job import SQLJob\n",
-    "from python_wsdb.types import DaemonServer\n",
+    "from mapepire_python.client.sql_job import SQLJob\n",
+    "from mapepire_python.types import DaemonServer\n",
     "import pandas as pd"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  },
   {
    "cell_type": "code",
    "execution_count": 16,

diff --git a/python_wsdb/client/query.py → mapepire_python/client/query.py b/python_wsdb/client/query.py → mapepire_python/client/query.py
@@ -2,8 +2,8 @@
 from enum import Enum
 from typing import Any, Dict, Generic, List, Optional, TypeVar, Union
 
-from python_wsdb.client.sql_job import SQLJob
-from python_wsdb.types import QueryOptions
+from ..types import QueryOptions
+from .sql_job import SQLJob
 
 T = TypeVar("T")
 

diff --git a/python_wsdb/client/sql_job.py → mapepire_python/client/sql_job.py b/python_wsdb/client/sql_job.py → mapepire_python/client/sql_job.py
@@ -5,7 +5,7 @@
 
 from websocket import WebSocket, create_connection
 
-from python_wsdb.types import DaemonServer, JobStatus, QueryOptions
+from ..types import DaemonServer, JobStatus, QueryOptions
 
 
 class SQLJob:
@@ -103,7 +103,7 @@ def query(
         Returns:
         Query: A configured Query object.
         """
-        from python_wsdb.client.query import Query
+        from .query import Query
 
         if opts is not None and not isinstance(opts, (dict, QueryOptions)):
             raise ValueError("opts must be a dictionary, a QueryOptions object, or None")

diff --git a/python_wsdb/pool.py → mapepire_python/pool.py b/python_wsdb/pool.py → mapepire_python/pool.py
@@ -2,8 +2,8 @@
 # from typing import List, Optional
 
 
-# from python_wsdb.client.sql_job import SQLJob
-# from python_wsdb.types import *
+# from mapepire_python.client.sql_job import SQLJob
+# from mapepire_python.types import *
 
 
 # @dataclass

diff --git a/python_wsdb/py.typed → mapepire_python/py.typed b/python_wsdb/py.typed → mapepire_python/py.typed
diff --git a/python_wsdb/ssl.py → mapepire_python/ssl.py b/python_wsdb/ssl.py → mapepire_python/ssl.py
@@ -2,7 +2,7 @@
 import ssl
 from typing import Optional
 
-from python_wsdb.types import DaemonServer
+from .types import DaemonServer
 
 
 def get_certificate(creds: DaemonServer) -> Optional[bytes]:

diff --git a/python_wsdb/types.py → mapepire_python/types.py b/python_wsdb/types.py → mapepire_python/types.py
diff --git a/python_wsdb/version.py → mapepire_python/version.py b/python_wsdb/version.py → mapepire_python/version.py