rearrange and add better intra-package references

jjjermiah · Nov 19, 2023 · f861774 · f861774
1 parent 1c3e285
commit f861774
Show file tree

Hide file tree

Showing 18 changed files with 29 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,4 +4,4 @@
 
 ## v0.1.0 (19/11/2023)
 
-- First release of `nbia_toolkit`!
+- First release of `nbiatoolkit`!
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -40,10 +40,10 @@ If you are proposing a feature:
 
 ## Get Started!
 
-Ready to contribute? Here's how to set up `nbia_toolkit` for local development.
+Ready to contribute? Here's how to set up `nbiatoolkit` for local development.
 
-1. Download a copy of `nbia_toolkit` locally.
-2. Install `nbia_toolkit` using `poetry`:
+1. Download a copy of `nbiatoolkit` locally.
+2. Install `nbiatoolkit` using `poetry`:
 
     ```console
     $ poetry install
@@ -69,5 +69,5 @@ Before you submit a pull request, check that it meets these guidelines:
 
 ## Code of Conduct
 
-Please note that the `nbia_toolkit` project is released with a
+Please note that the `nbiatoolkit` project is released with a
 Code of Conduct. By contributing to this project you agree to abide by its terms.
diff --git a/README.md b/README.md
@@ -8,14 +8,14 @@ See the [Wiki](https://github.com/jjjermiah/NBIA-toolkit/wiki) for more informat
 
 
 ### none of this works yet lol but it will soon
-# nbia_toolkit
+# nbiatoolkit
 
 A python package to query the National Biomedical Imaging Archive (NBIA) database.
 
 ## Installation
 
 ```bash
-$ pip install nbia_toolkit
+$ pip install nbiatoolkit
 ```
 
 ## Usage
@@ -28,8 +28,8 @@ Interested in contributing? Check out the contributing guidelines. Please note t
 
 ## License
 
-`nbia_toolkit` was created by Jermiah Joseph. It is licensed under the terms of the MIT license.
+`nbiatoolkit` was created by Jermiah Joseph. It is licensed under the terms of the MIT license.
 
 ## Credits
 
-`nbia_toolkit` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
+`nbiatoolkit` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
diff --git a/driver.py b/driver.py
@@ -1,4 +1,4 @@
-from src.nbia import NBIAClient
+from nbiatoolkit import NBIAClient
 import requests
 from pprint import pprint
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "nbia_toolkit"
+name = "nbiatoolkit"
 version = "0.1.0"
 description = "A python package to query the National Biomedical Imaging Archive (NBIA) database."
 authors = ["Jermiah Joseph"]

diff --git a/src/__init__.py → src/nbiatoolkit/__init__.py b/src/__init__.py → src/nbiatoolkit/__init__.py
diff --git a/src/auth.py → src/nbiatoolkit/auth.py b/src/auth.py → src/nbiatoolkit/auth.py
diff --git a/src/nbia.py → src/nbiatoolkit/nbia.py b/src/nbia.py → src/nbiatoolkit/nbia.py
@@ -1,6 +1,6 @@
-from src.utils.nbia_endpoints import NBIA_ENDPOINTS
-from src.auth import OAuth2
-from src.utils.logger import setup_logger
+from nbiatoolkit.auth import OAuth2
+from nbiatoolkit.utils.nbia_endpoints import NBIA_ENDPOINTS
+from nbiatoolkit.utils.logger import setup_logger
 import requests
 from requests.exceptions import JSONDecodeError as JSONDecodeError
 class NBIAClient:

diff --git a/src/utils/README.md → src/nbiatoolkit/utils/README.md b/src/utils/README.md → src/nbiatoolkit/utils/README.md
diff --git a/src/nbiatoolkit/utils/__init__.py b/src/nbiatoolkit/utils/__init__.py
@@ -0,0 +1,6 @@
+from .logger import setup_logger
+from .nbia_endpoints import NBIA_ENDPOINTS
+__all__ = [
+    "setup_logger",
+    "NBIA_ENDPOINTS"
+]
diff --git a/src/utils/logger.py → src/nbiatoolkit/utils/logger.py b/src/utils/logger.py → src/nbiatoolkit/utils/logger.py
diff --git a/src/utils/nbia_endpoints.py → src/nbiatoolkit/utils/nbia_endpoints.py b/src/utils/nbia_endpoints.py → src/nbiatoolkit/utils/nbia_endpoints.py
diff --git a/src/utils/__init__.py b/src/utils/__init__.py
diff --git a/src/tests/__init__.py → tests/__init__.py b/src/tests/__init__.py → tests/__init__.py
diff --git a/src/tests/oldtest_nbia.py → tests/oldtest_nbia.py b/src/tests/oldtest_nbia.py → tests/oldtest_nbia.py
diff --git a/src/tests/test_auth.py → tests/test_auth.py b/src/tests/test_auth.py → tests/test_auth.py
@@ -4,7 +4,7 @@
 # pytest -v -s 
 
 import pytest
-from ..auth import OAuth2
+from nbiatoolkit import OAuth2
 import time 
 
 

diff --git a/src/tests/test_nbia.py → tests/test_nbia.py b/src/tests/test_nbia.py → tests/test_nbia.py
@@ -1,7 +1,7 @@
 #####
 # pytest -v -n 8
 import pytest
-from ..nbia import NBIAClient
+from nbiatoolkit import NBIAClient
 
 @pytest.fixture(scope="session")
 def nbia_client():