Refactor to noteable pkg (#101)

* Rename package to noteable

* Touchups

* Changelog

* Fix tests invocations.

* More renaming

* isort

---------

Co-authored-by: Elijah Wilson <[email protected]>

Author: James Robinson

.github/workflows/main.yaml

@@ -52,15 +52,15 @@ jobs:
 
       # Run all of the tests
       - name: Flake8 - Style guide enforcement
-        run: poetry run flake8 noteable_magics/ tests/ --count --show-source --statistics --benchmark
+        run: poetry run flake8 noteable/ tests/ --count --show-source --statistics --benchmark
         if: ${{ matrix.python-version == 3.9 }}
 
       - name: Black - Format check
-        run: poetry run black --diff noteable_magics/ tests/
+        run: poetry run black --diff noteable/ tests/
         if: ${{ matrix.python-version == 3.9 }}
 
       - name: Isort - Import format check
-        run: poetry run isort --diff --check noteable_magics/ tests/
+        run: poetry run isort --diff --check noteable/ tests/
         if: ${{ matrix.python-version == 3.9 }}
 
       - name: Safety - Python dependency vulnerability check

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `%%sql @e456456 my_df << select a, b, c from foo` variable assignment syntax will now always return the resulting dataframe as well as silently assign to the interpreter variable (`my_df` in this case) as side-effect. Previously would only assign to the interpreter variable and announce the fact with a print(), while having no return result.
 - Now use jinjasql for SQL cell template expansion, not simple string.Template.
 - Simpler message printed as the cell's side-effect if an unknown datasource handle is attempted.
+- Repackaged all code to be in 'noteable' toplevel package, not 'noteable_magics.'
 
 ## [2.0.0] - 2022-03-15
 ### Changed

noteable_magics/__init__.py renamed to noteable/__init__.py

@@ -1,6 +1,6 @@
 import pkg_resources
 
-__version__ = pkg_resources.get_distribution("noteable_magics").version
+__version__ = pkg_resources.get_distribution("noteable").version
 
 from .data_loader import LOCAL_DB_CONN_HANDLE, NoteableDataLoaderMagic, get_db_connection
 from .datasources import bootstrap_datasources
@@ -11,7 +11,6 @@
 
 
 def load_ipython_extension(ipython):
-
     # Initialize any remote datasource connections
     bootstrap_datasources()
 

noteable_magics/command.py renamed to noteable/command.py

@@ -8,7 +8,7 @@
 from traitlets import Bool, Int
 from traitlets.config import Configurable
 
-from noteable_magics.sql.connection import Connection
+from noteable.sql.connection import Connection
 
 EXCEL_MIMETYPES = {
     "application/vnd.ms-excel",  # .xls

noteable_magics/data_loader.py renamed to noteable/data_loader.py

@@ -10,12 +10,12 @@
 from sqlalchemy.engine import URL
 
 # ipython-sql thinks mighty highly of isself with this package name.
-import noteable_magics.sql.connection
-from noteable_magics.sql.run import add_commit_blacklist_dialect
+import noteable.sql.connection
+from noteable.sql.run import add_commit_blacklist_dialect
 
 DEFAULT_SECRETS_DIR = Path('/vault/secrets')
 
-from noteable_magics.datasource_postprocessing import post_processor_by_drivername
+from noteable.datasource_postprocessing import post_processor_by_drivername
 
 logger = structlog.get_logger(__name__)
 
@@ -103,7 +103,7 @@ def bootstrap_datasource(
             )
 
             # Remember the failure so can be shown if / when human tries to use the connection.
-            noteable_magics.sql.connection.Connection.add_bootstrapping_failure(
+            noteable.sql.connection.Connection.add_bootstrapping_failure(
                 datasource_id, human_name, str(e)
             )
 
@@ -133,7 +133,7 @@ def bootstrap_datasource(
 
     # Teach ipython-sql about the connection!
     try:
-        noteable_magics.sql.connection.Connection.set(
+        noteable.sql.connection.Connection.set(
             connection_url,
             name=f'@{datasource_id}',
             human_name=human_name,
@@ -154,7 +154,7 @@ def bootstrap_datasource(
         )
 
         # Remember the failure so can be shown if / when human tries to use the connection.
-        noteable_magics.sql.connection.Connection.add_bootstrapping_failure(
+        noteable.sql.connection.Connection.add_bootstrapping_failure(
             datasource_id, human_name, str(e)
         )