Merge pull request #20 from datatractor/ml-evs/fixes

Fix mismatched package/module name and update README

Author: PeterKraus

.github/workflows/build-docs.yml

@@ -26,7 +26,7 @@ jobs:
 
             - name: Build docs
               run: |
-                  sphinx-apidoc -o docs/source/apidoc beam
+                  sphinx-apidoc -o docs/source/apidoc datatractor_beam
                   sphinx-build -b html docs/source/ public/main
 
             - name: Upload docs artifact

README.md

@@ -48,7 +48,7 @@ pip install .
 ### Usage
 
 #### As a Python module
-To extract data from a file, you can use the `extract` function from the `beam` module inside your own Python code:
+To extract data from a file, you can use the `extract` function from the `datatractor_beam` module inside your own Python code:
 
 ```python
 from beam import extract

beam/__init__.py datatractor_beam/__init__.pybeam/__init__.py renamed to datatractor_beam/__init__.py

@@ -13,7 +13,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath(os.path.join("..", "..", "beam")))
+sys.path.insert(0, os.path.abspath(os.path.join("..", "..", "datatractor_beam")))
 
 version = "main"
 

docs/source/conf.py

@@ -7,7 +7,7 @@ Datatractor Beam: Reference implementation of the Datatractor API
    :hidden:
    :glob:
 
-   apidoc/beam
+   apidoc/datatractor_beam
 
 
 Documentation of |beamrepo|_, the reference implementation of the Datatractor API,

docs/source/index.rst

@@ -9,7 +9,7 @@ source = "vcs"
 version-file = "_version.py"
 
 [tool.hatch.build.targets.wheel]
-packages = ["beam"]
+packages = ["datatractor_beam"]
 
 [project]
 name = "datatractor-beam"
@@ -57,7 +57,7 @@ dev = [
 repository = "https://github.com/datatractor/beam"
 
 [project.scripts]
-datatractor = "beam:run_datatractor"
+datatractor = "datatractor_beam:run_datatractor"
 
 [tool.ruff]
 extend-exclude = [

pyproject.toml

@@ -1,7 +1,7 @@
 import pathlib
 import urllib.request
 
-from beam import extract
+from datatractor_beam import extract
 
 # Download an example MPR file from the registry
 download_path = pathlib.Path(__file__).parent / "data" / "example.mpr"

scripts/biologic-mpr-example.py

@@ -4,7 +4,7 @@
 
 import pytest
 
-from beam import ExtractorPlan, SupportedExecutionMethod, extract
+from datatractor_beam import ExtractorPlan, SupportedExecutionMethod, extract
 
 
 @pytest.fixture