Deprecating import via 'peakrdl.html' namespace package. #31

Author: amykyta3

.github/workflows/build.yml

@@ -30,7 +30,7 @@ jobs:
 
       - name: Run Lint
         run: |
-          pylint --rcfile test/pylint.rc peakrdl
+          pylint --rcfile test/pylint.rc peakrdl_html
 
 #-------------------------------------------------------------------------------
   build_sdist:

MANIFEST.in

@@ -1,3 +1,3 @@
-recursive-include peakrdl/html/static *
-recursive-include peakrdl/html/templates *
-recursive-exclude test *
+recursive-include src/peakrdl_html/static *
+recursive-include src/peakrdl_html/templates *
+recursive-exclude test *

README.md

@@ -8,7 +8,7 @@
 sys.path.insert(0, os.path.join(this_dir, "../"))
 
 from systemrdl import RDLCompiler, RDLCompileError
-from peakrdl.html import HTMLExporter
+from peakrdl_html import HTMLExporter
 
 #===============================================================================
 input_files = sys.argv[1:]

example/generate_docs.py

@@ -5,7 +5,7 @@
     long_description = fh.read()
 
 
-with open(os.path.join("peakrdl/html", "__about__.py"), encoding='utf-8') as f:
+with open(os.path.join("src/peakrdl_html", "__about__.py"), encoding='utf-8') as f:
     v_dict = {}
     exec(f.read(), v_dict)
     version = v_dict['__version__']
@@ -19,7 +19,11 @@
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/SystemRDL/PeakRDL-html",
-    packages=['peakrdl.html'],
+    package_dir={'': 'src'},
+    packages=[
+        'peakrdl_html',
+        'peakrdl.html', # backwards compatibility shim
+    ],
     include_package_data=True,
     install_requires=[
         "systemrdl-compiler>=1.13.0",

peakrdl/html/__about__.py

@@ -0,0 +1,21 @@
+import warnings
+
+# Load modules
+from peakrdl_html import __about__
+from peakrdl_html import exporter
+from peakrdl_html import search_indexer
+from peakrdl_html import stringify
+
+# hoist internal objects
+from peakrdl_html.exporter import HTMLExporter
+
+
+warnings.warn(
+"""
+================================================================================
+Importing via namespace package 'peakrdl.html' is deprecated and will be
+removed in the next release.
+Change your imports to load the package using 'peakrdl_html' instead.
+For more details, see: https://github.com/SystemRDL/PeakRDL/issues/4
+================================================================================
+""", DeprecationWarning, stacklevel=2)

setup.py

@@ -0,0 +1 @@
+__version__ = "2.6.0"