diff --git a/pyproject.toml b/pyproject.toml index 9121c6c..4492001 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [project] -name = "data-shield" +name = "data_shield" version = "0.1.0" description = "Add your description here" readme = "README.md" @@ -12,8 +12,8 @@ dependencies = [ "specklepy>=2.21.3", ] -[tool.setuptools] -packages = ["src"] +[tool.setuptools.packages.find] +where = ["src"] [tool.ruff] select = [ diff --git a/requirements.txt b/requirements.txt index fc8c61e..abd9bb5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -42,7 +42,7 @@ iniconfig==2.1.0 multidict==6.2.0 # via yarl mypy==1.15.0 - # via speckle-automate-data-shield (pyproject.toml) + # via speckle-automate-data_shield (pyproject.toml) mypy-extensions==1.0.0 # via mypy packaging==24.2 @@ -58,9 +58,9 @@ pydantic==2.10.6 pydantic-core==2.27.2 # via pydantic pydantic-settings==2.8.1 - # via speckle-automate-data-shield (pyproject.toml) + # via speckle-automate-data_shield (pyproject.toml) pytest==8.3.5 - # via speckle-automate-data-shield (pyproject.toml) + # via speckle-automate-data_shield (pyproject.toml) python-dotenv==1.0.1 # via pydantic-settings requests==2.32.3 @@ -70,13 +70,13 @@ requests==2.32.3 requests-toolbelt==1.0.0 # via gql ruff==0.11.2 - # via speckle-automate-data-shield (pyproject.toml) + # via speckle-automate-data_shield (pyproject.toml) sniffio==1.3.1 # via # anyio # httpx specklepy==2.21.3 - # via speckle-automate-data-shield (pyproject.toml) + # via speckle-automate-data_shield (pyproject.toml) stringcase==1.2.0 # via specklepy typing-extensions==4.12.2 diff --git a/src/data-shield/__init__.py b/src/data-shield/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/src/data_shield/__init__.py b/src/data_shield/__init__.py new file mode 100644 index 0000000..37b2a90 --- /dev/null +++ b/src/data_shield/__init__.py @@ -0,0 +1,9 @@ +# You can expose frequently used imports for convenience +from .actions import PrefixRemovalAction +from .function import automate_function +from .inputs import FunctionInputs, SanitizationMode +from .rules import ParameterRules +from .traversal import get_data_traversal_rules + +__all__ = ["PrefixRemovalAction", "automate_function", "FunctionInputs", "SanitizationMode", "ParameterRules", + "get_data_traversal_rules"] diff --git a/src/data-shield/actions.py b/src/data_shield/actions.py similarity index 99% rename from src/data-shield/actions.py rename to src/data_shield/actions.py index f770611..26ea2a1 100644 --- a/src/data-shield/actions.py +++ b/src/data_shield/actions.py @@ -1,10 +1,11 @@ from abc import ABC, abstractmethod from collections import defaultdict from typing import Dict, List, Optional + from speckle_automate import AutomationContext from specklepy.objects import Base -from src.rules import ParameterRules +from data_shield import ParameterRules # Our main goal is to define actions that can be taken on parameters. diff --git a/src/data-shield/function.py b/src/data_shield/function.py similarity index 95% rename from src/data-shield/function.py rename to src/data_shield/function.py index 4a49161..b0ade91 100644 --- a/src/data-shield/function.py +++ b/src/data_shield/function.py @@ -1,8 +1,7 @@ from speckle_automate import AutomationContext from specklepy.objects import Base -from src.actions import PrefixRemovalAction -from src.inputs import FunctionInputs, SanitizationMode -from traversal import get_data_traversal_rules + +from data_shield import FunctionInputs, SanitizationMode, PrefixRemovalAction, get_data_traversal_rules class ParameterProcessor: diff --git a/src/data-shield/helpers.py b/src/data_shield/helpers.py similarity index 100% rename from src/data-shield/helpers.py rename to src/data_shield/helpers.py diff --git a/src/data-shield/inputs.py b/src/data_shield/inputs.py similarity index 100% rename from src/data-shield/inputs.py rename to src/data_shield/inputs.py diff --git a/src/data-shield/rule_processor.py b/src/data_shield/rule_processor.py similarity index 100% rename from src/data-shield/rule_processor.py rename to src/data_shield/rule_processor.py diff --git a/src/data-shield/rules.py b/src/data_shield/rules.py similarity index 100% rename from src/data-shield/rules.py rename to src/data_shield/rules.py diff --git a/src/data-shield/traversal.py b/src/data_shield/traversal.py similarity index 100% rename from src/data-shield/traversal.py rename to src/data_shield/traversal.py