Merge pull request #16 from statisticsnorway/structure-repo

Structure repo into src and generated directories
statisticsnorway · Nov 15, 2023 · 2f9ec48 · 2f9ec48
2 parents 4435d2a + 7c48ce3
commit 2f9ec48
Show file tree

Hide file tree

Showing 15 changed files with 6 additions and 4 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -13,3 +13,4 @@ jobs:
         uses: JRubics/[email protected]
         with:
           pypi_token: ${{ secrets.PYPI_TOKEN }}
+          package_directory: "generated/python/datadoc_model_legacy"
diff --git a/README.md b/README.md
@@ -16,3 +16,7 @@ This package contains pydantic models defining the fields and data types used in
 Fields and data types defined in models in this package are specified on internal Statistics Norway wiki pages:
 
 - <https://statistics-norway.atlassian.net/l/cp/kQ9rpshS>
+
+## Code generation
+
+The models are defined as [JSON Schema](https://json-schema.org/) documents. These reside within the `src/` directory in this repo. Code for a range of languages is generated from the JSON Schema and will live inside the `generated/` directory, with a subdirectory for each language.
diff --git a/poetry.lock → generated/python/datadoc_model/poetry.lock b/poetry.lock → generated/python/datadoc_model/poetry.lock
diff --git a/pyproject.toml → ...rated/python/datadoc_model/pyproject.toml b/pyproject.toml → ...rated/python/datadoc_model/pyproject.toml
@@ -7,9 +7,7 @@ license = "MIT"
 readme = "README.md"
 repository = "https://github.com/statisticsnorway/ssb-datadoc-model"
 
-packages = [
-    { include = "datadoc_model" },
-]
+packages = [{ include = "datadoc_model" }]
 
 [tool.poetry.dependencies]
 python = ">=3.8"
@@ -18,7 +16,6 @@ pydantic = ">=2.4.0"
 [tool.poetry.dev-dependencies]
 black = "*"
 ipython = "*"
-bump2version = "*"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

diff --git a/.bumpversion.cfg → ...hon/datadoc_model_legacy/.bumpversion.cfg b/.bumpversion.cfg → ...hon/datadoc_model_legacy/.bumpversion.cfg
diff --git a/datadoc_model/BaseModel.py → ...c_model_legacy/datadoc_model/BaseModel.py b/datadoc_model/BaseModel.py → ...c_model_legacy/datadoc_model/BaseModel.py
diff --git a/datadoc_model/Enums.py → ...tadoc_model_legacy/datadoc_model/Enums.py b/datadoc_model/Enums.py → ...tadoc_model_legacy/datadoc_model/Enums.py
diff --git a/datadoc_model/LanguageStrings.py → ...l_legacy/datadoc_model/LanguageStrings.py b/datadoc_model/LanguageStrings.py → ...l_legacy/datadoc_model/LanguageStrings.py
diff --git a/datadoc_model/LanguageStringsEnum.py → ...gacy/datadoc_model/LanguageStringsEnum.py b/datadoc_model/LanguageStringsEnum.py → ...gacy/datadoc_model/LanguageStringsEnum.py
diff --git a/datadoc_model/Model.py → ...tadoc_model_legacy/datadoc_model/Model.py b/datadoc_model/Model.py → ...tadoc_model_legacy/datadoc_model/Model.py
diff --git a/datadoc_model/__init__.py → ...oc_model_legacy/datadoc_model/__init__.py b/datadoc_model/__init__.py → ...oc_model_legacy/datadoc_model/__init__.py
diff --git a/datadoc-json-schema/datadoc-json-schema.json → ...adoc-json-schema/datadoc-json-schema.json b/datadoc-json-schema/datadoc-json-schema.json → ...adoc-json-schema/datadoc-json-schema.json
diff --git a/...oc-json-schema/no/languageStringType.json → ...oc-json-schema/no/languageStringType.json b/...oc-json-schema/no/languageStringType.json → ...oc-json-schema/no/languageStringType.json
diff --git a/...c-json-schema/no/temporalityTypeType.json → ...c-json-schema/no/temporalityTypeType.json b/...c-json-schema/no/temporalityTypeType.json → ...c-json-schema/no/temporalityTypeType.json
diff --git a/datadoc-json-schema/no/unitType.json → src/datadoc-json-schema/no/unitType.json b/datadoc-json-schema/no/unitType.json → src/datadoc-json-schema/no/unitType.json