envlib 0.0.2__tar.gz → 0.1.0__tar.gz

envlib-0.1.0/.gitignore

@@ -0,0 +1,119 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+junit/
+junit.xml
+test.db
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+.ruff*
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# .vscode
+.vscode/
+
+# OS files
+.DS_Store
+
+# Temp data
+data/*
+
+# Test config files
+/envlib/tests/*.toml
+/envlib/tests/*.yml

envlib-0.1.0/LICENSE

@@ -0,0 +1,16 @@
+Apache Software License 2.0
+
+Copyright (c) 2026, Mike Kittridge
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

envlib-0.1.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: envlib
+Version: 0.1.0
+Summary: The environmental library
+Project-URL: Documentation, https://mullenkamp.github.io/envlib/
+Project-URL: Source, https://github.com/envlib
+Author-email: mullenkamp <mullenkamp1@gmail.com>
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Requires-Dist: booklet>=0.12.5
+Requires-Dist: cfdb>=0.9.0
+Requires-Dist: ebooklet>=0.9.1
+Requires-Dist: pyproj
+Requires-Dist: shapely>=2.0
+Requires-Dist: urllib3
+Description-Content-Type: text/markdown
+
+# envlib
+
+<p align="center">
+    <em>The environmental library</em>
+</p>
+
+[![build](https://github.com/envlib/workflows/Build/badge.svg)](https://github.com/envlib/actions)
+[![codecov](https://codecov.io/gh/mullenkamp/envlib/branch/main/graph/badge.svg)](https://codecov.io/gh/mullenkamp/envlib)
+[![PyPI version](https://badge.fury.io/py/envlib.svg)](https://badge.fury.io/py/envlib)
+
+---
+
+**Source Code**: <a href="https://github.com/envlib" target="_blank">https://github.com/envlib</a>
+
+---
+## Overview
+envlib is a distributed database and catalogue for environmental data. It uses controlled vocabulary and standarized metadata to make it easy for users to query and access data. It uses cfdb as the backend. The metadata structure is based on tethysts.
+
+
+## Development
+
+### Setup environment
+
+We use [UV](https://docs.astral.sh/uv/) to manage the development environment and production build. 
+
+```bash
+uv sync
+```
+
+### Run unit tests
+
+You can run all the tests with:
+
+```bash
+uv run pytest
+```
+
+### Format the code
+
+Execute the following commands to apply linting and check typing:
+
+```bash
+uv run ruff check .
+uv run black --check --diff .
+uv run mypy --install-types --non-interactive envlib
+```
+
+To auto-format:
+
+```bash
+uv run black .
+uv run ruff check --fix .
+```
+
+## License
+
+This project is licensed under the terms of the Apache Software License 2.0.

envlib-0.1.0/README.md

@@ -0,0 +1,57 @@
+# envlib
+
+<p align="center">
+    <em>The environmental library</em>
+</p>
+
+[![build](https://github.com/envlib/workflows/Build/badge.svg)](https://github.com/envlib/actions)
+[![codecov](https://codecov.io/gh/mullenkamp/envlib/branch/main/graph/badge.svg)](https://codecov.io/gh/mullenkamp/envlib)
+[![PyPI version](https://badge.fury.io/py/envlib.svg)](https://badge.fury.io/py/envlib)
+
+---
+
+**Source Code**: <a href="https://github.com/envlib" target="_blank">https://github.com/envlib</a>
+
+---
+## Overview
+envlib is a distributed database and catalogue for environmental data. It uses controlled vocabulary and standarized metadata to make it easy for users to query and access data. It uses cfdb as the backend. The metadata structure is based on tethysts.
+
+
+## Development
+
+### Setup environment
+
+We use [UV](https://docs.astral.sh/uv/) to manage the development environment and production build. 
+
+```bash
+uv sync
+```
+
+### Run unit tests
+
+You can run all the tests with:
+
+```bash
+uv run pytest
+```
+
+### Format the code
+
+Execute the following commands to apply linting and check typing:
+
+```bash
+uv run ruff check .
+uv run black --check --diff .
+uv run mypy --install-types --non-interactive envlib
+```
+
+To auto-format:
+
+```bash
+uv run black .
+uv run ruff check --fix .
+```
+
+## License
+
+This project is licensed under the terms of the Apache Software License 2.0.

envlib-0.1.0/envlib/__init__.py

@@ -0,0 +1,9 @@
+"""envlib: a distributed database and catalogue for environmental data."""
+
+from envlib import vocabularies
+from envlib.catalogue import Catalogue, DatasetRef
+from envlib.metadata import Metadata, ValidationError, compute_station_id
+
+__version__ = '0.1.0'
+
+__all__ = ['Catalogue', 'DatasetRef', 'Metadata', 'ValidationError', 'compute_station_id', 'vocabularies']