Update project structure and naming conventions

- Changed project name format from hyphen to underscore.
- Updated package finding configuration in setup tools.
- Renamed several files and adjusted imports accordingly.
- Removed an empty helper file that was no longer needed.
- Added a new `__init__.py` for better module organisation.
This commit is contained in:
Jonathon Broughton
2025-03-24 13:27:48 +00:00
parent 731c735fce
commit e753bdb4e8
11 changed files with 21 additions and 12 deletions
+3 -3
View File
@@ -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 = [
+5 -5
View File
@@ -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
View File
+9
View File
@@ -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"]
@@ -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.
@@ -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: