Setup project structure

larktools/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present SPRENGER Julia, NEA/SCI/DB <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

larktools/README.md

@@ -0,0 +1,21 @@
+# larktools
+
+[![PyPI - Version](https://img.shields.io/pypi/v/larktools.svg)](https://pypi.org/project/larktools)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/larktools.svg)](https://pypi.org/project/larktools)
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install larktools
+```
+
+## License
+
+`larktools` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

larktools/pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "larktools"
+dynamic = ["version"]
+description = 'A simple grammar for working with hierarchical data formats'
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "SPRENGER Julia, NEA/SCI/DB", email = "[email protected]" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = []
+
+[project.urls]
+Documentation = "https://github.com/SPRENGER Julia, NEA/SCI/DB/larktools#readme"
+Issues = "https://github.com/SPRENGER Julia, NEA/SCI/DB/larktools/issues"
+Source = "https://github.com/SPRENGER Julia, NEA/SCI/DB/larktools"
+
+[tool.hatch.version]
+path = "src/larktools/__about__.py"
+
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/larktools tests}"
+
+[tool.coverage.run]
+source_pkgs = ["larktools", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/larktools/__about__.py",
+]
+
+[tool.coverage.paths]
+larktools = ["src/larktools", "*/larktools/src/larktools"]
+tests = ["tests", "*/larktools/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

larktools/src/larktools/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2024-present SPRENGER Julia, NEA/SCI/DB <[email protected]>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.0.1"

larktools/src/larktools/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present SPRENGER Julia, NEA/SCI/DB <[email protected]>
+#
+# SPDX-License-Identifier: MIT

larktools/tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present SPRENGER Julia, NEA/SCI/DB <[email protected]>
+#
+# SPDX-License-Identifier: MIT