openyieldtables 0.0.0__tar.gz

openyieldtables-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 to Tree.ly FlexCo and FMM GmbH
+
+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.

openyieldtables-0.0.0/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.1
+Name: openyieldtables
+Version: 0.0.0
+Summary: 
+Author: Tree.ly
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pandas (>=2.2.1,<3.0.0)
+Requires-Dist: pydantic (>=2.6.4,<3.0.0)
+Description-Content-Type: text/markdown
+
+# 🌲 openyieldtables
+
+An open source Python library for yield tables.
+
+## Quickstart
+
+Download the latest version of the library from PyPI:
+
+```bash
+pip install openyieldtables
+```
+
+Import the library and load a yield table:
+
+```python
+from openyieldtables.yieldtables import (
+    get_yield_table_data,
+    get_yield_tables_meta,
+)
+
+# Get the metadata of all available yield tables
+yield_tables_meta = get_yield_tables_meta()
+
+# Get the data of a yield table by its ID
+yield_table = get_yield_table(1)
+```
+
+## Documentation
+
+You can find the documentation [here](https://openyieldtables.readthedocs.io/latest/).
+
+## Contributing
+
+We are happy about every contribution! Please follow our 
+contribution guideline](https://github.com/treely/openyieldtables/blob/main/CONTRIBUTING.md).
+
+## About
+
+`openyieldtables` is maintained by [Tree.ly](https://tree.ly) and [FMM](https://www.fmm.at/).
+

openyieldtables-0.0.0/README.md

@@ -0,0 +1,39 @@
+# 🌲 openyieldtables
+
+An open source Python library for yield tables.
+
+## Quickstart
+
+Download the latest version of the library from PyPI:
+
+```bash
+pip install openyieldtables
+```
+
+Import the library and load a yield table:
+
+```python
+from openyieldtables.yieldtables import (
+    get_yield_table_data,
+    get_yield_tables_meta,
+)
+
+# Get the metadata of all available yield tables
+yield_tables_meta = get_yield_tables_meta()
+
+# Get the data of a yield table by its ID
+yield_table = get_yield_table(1)
+```
+
+## Documentation
+
+You can find the documentation [here](https://openyieldtables.readthedocs.io/latest/).
+
+## Contributing
+
+We are happy about every contribution! Please follow our 
+contribution guideline](https://github.com/treely/openyieldtables/blob/main/CONTRIBUTING.md).
+
+## About
+
+`openyieldtables` is maintained by [Tree.ly](https://tree.ly) and [FMM](https://www.fmm.at/).

openyieldtables-0.0.0/pyproject.toml

@@ -0,0 +1,77 @@
+[tool.poetry]
+name = "openyieldtables"
+version = "0.0.0"
+description = ""
+authors = ["Tree.ly", "FMM"]
+readme = "README.md"
+packages = [
+  { include = "openyieldtables", from = "src" },
+  { include = "src/openyieldtables/py.typed" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+pydantic = "^2.6.4"
+pandas = "^2.2.1"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--cov=openyieldtables --cov-report term-missing --cov-report html"
+
+[tool.black]
+line-length = 79
+target-version = ['py39']
+include = '\.pyi?$'
+exclude = '''
+(
+  /(
+      \.eggs         # exclude a few common directories in the
+    | \.git          # root of the project
+    | \.hg
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | _build
+    | buck-out
+    | build
+    | dist
+  )/
+)
+'''
+
+[tool.isort]
+profile = "black"
+line_length = 79
+force_sort_within_sections = true
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:tool.poetry.version"]
+branch = "main"
+build_command = "pip install poetry==1.8.2 && poetry build"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.1.1"
+pytest-cov = "^5.0.0"
+flake8 = "^7.0.0"
+black = "^24.3.0"
+isort = "^5.13.2"
+pre-commit = "^3.7.0"
+mypy = "^1.9.0"
+pandas-stubs = "^2.2.1.240316"
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = "^1.5.3"
+mkdocstrings = { extras = ["python"], version = "^0.24.3" }
+
+[tool.poetry.group.api.dependencies]
+fastapi = "^0.110.1"
+uvicorn = "^0.29.0"
+httpx = "^0.27.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"