Create a standalone package

Do not use ofxstatement namespace packages anymore, because they provide no benenfits anymore, but create some problems (e.g. VS Code can't resolve objects, imported from ofxstatement). Makes it simpler to create plugins using popular tools.
kedder · Jan 17, 2024 · ba2b501 · ba2b501
1 parent 36638cc
commit ba2b501
Show file tree

Hide file tree

Showing 7 changed files with 4 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -47,9 +47,9 @@ To create your own plugin, follow these steps:
   lists plugins you are registering within ofxstatement. Give meaningful
   name to the plugin and provide plugin class name
 * Replace contents of ``README.rst`` with description of your plugin
-* Rename ``ofxstatement/plugins/sample.py`` to match plugin package name
+* Rename ``ofxstatement_sample`` to match plugin package name
   you have provided in ``entry_points`` parameter.
-* Open renamed sample.py and rename ``SamplePlugin`` and ``SampleParser``
+* Open the ``plugin.py`` and rename ``SamplePlugin`` and ``SampleParser``
   classes to match your plugin class name.
 * Now, draw the rest of the owl (c).
 

diff --git a/setup.py b/setup.py
@@ -31,9 +31,8 @@
     ],
     packages=find_packages("src"),
     package_dir={"": "src"},
-    namespace_packages=["ofxstatement", "ofxstatement.plugins"],
     entry_points={
-        "ofxstatement": ["sample = ofxstatement.plugins.sample:SamplePlugin"]
+        "ofxstatement": ["sample = ofxstatement_sample.plugin:SamplePlugin"]
     },
     install_requires=["ofxstatement"],
     include_package_data=True,

diff --git a/src/ofxstatement/__init__.py b/src/ofxstatement/__init__.py
diff --git a/src/ofxstatement/plugins/__init__.py b/src/ofxstatement/plugins/__init__.py
diff --git a/src/ofxstatement_sample/__init__.py b/src/ofxstatement_sample/__init__.py
diff --git a/src/ofxstatement/plugins/sample.py → src/ofxstatement_sample/plugin.py b/src/ofxstatement/plugins/sample.py → src/ofxstatement_sample/plugin.py
diff --git a/tests/test_sample.py b/tests/test_sample.py
@@ -2,7 +2,7 @@
 
 from ofxstatement.ui import UI
 
-from ofxstatement.plugins.sample import SamplePlugin
+from ofxstatement_sample.plugin import SamplePlugin
 
 
 def test_sample() -> None: