pyetp 0.0.38__tar.gz → 0.0.43__tar.gz

pyetp-0.0.43/CONTRIBUTING.md

@@ -0,0 +1,123 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at https://github.com/equinor/pyetp/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* pyetp version
+* Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the Git issues for bugs. Anything tagged with "bug"
+and "help wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the Git issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+### Write Documentation
+
+We could always use more documentation, whether as part of the
+official docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue
+at https://github.com/equinor/pyetp/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+
+## Get Started!
+
+Ready to contribute? Here's how to set up ``pyetp`` for local development.
+
+1. Fork the ``pyetp`` repo on Github equinor to your personal user
+2. Clone your fork locally
+3. Start the development container. [Info](https://containers.dev/)
+4. Create a branch for local development:
+5. Make your changes locally.
+
+6. When you're done making changes, check that your changes pass flake8 and the tests
+```
+poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude=docs
+poetry run pytest --cov-report=term-missing --cov=pyetp tests/ | tee pytest-coverage.txt
+```
+
+7. Commit your changes and push your branch
+8. Submit a pull request.
+
+
+## Writing commit messages
+
+Commit messages should be clear and follow a few basic rules. Example:
+
+```
+    ENH: add functionality X to numpy.<submodule>.
+```
+The first line of the commit message starts with a capitalized acronym
+(options listed below) indicating what type of commit this is.  Then a blank
+line, then more text if needed.  Lines shouldn't be longer than 72
+characters.  If the commit is related to a ticket, indicate that with
+``"See #3456", "Cf. #3344, "See ticket 3456", "Closes #3456"`` or similar.
+
+Read Chris Beams hints on commit messages <https://chris.beams.io/posts/git-commit/>.
+
+Describing the motivation for a change, the nature of a bug for bug fixes or
+some details on what an enhancement does are also good to include in a commit message.
+Messages should be understandable without looking at the code changes.
+A commit message like FIX: fix another one is an example of what not to do;
+the reader has to go look for context elsewhere.
+
+Standard acronyms to start the commit message with are:
+
+```
+    API: an (incompatible) API change (will be rare)
+    PERF: performance or bench-marking
+    BLD: change related to building
+    BUG: bug fix
+    FIX: fixes wrt to technical issues, e.g. wrong requirements.txt
+    DEP: deprecate something, or remove a deprecated object
+    DOC: documentation, addition, updates
+    ENH: enhancement, new functionality
+    CLN: code cleanup, maintenance commit (refactoring, typos, PEP, etc.)
+    REV: revert an earlier commit
+    TST: addition or modification of tests
+    REL: related to release
+```
+
+## Type hints
+
+[PEP 484](https://peps.python.org/pep-0484/)
+
+## Docstrings
+
+[Numpy](https://numpydoc.readthedocs.io/en/latest/format.html)
+
+## Style guidelines
+
+[PEP 8](https://peps.python.org/pep-0008/)
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docstrings and/or docs should be updated.
+
+

pyetp-0.0.43/MANIFEST.in

@@ -0,0 +1 @@
+exclude data/* tests/* examples/* .devcontainer/* .github/workflows/* .gitattributes .gitignore

pyetp-0.0.43/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: pyetp
+Version: 0.0.43
+Summary: Interface with OSDU RDDMS using ETP protocol
+Author-email: Adam Cheng <52572642+adamchengtkc@users.noreply.github.com>
+License-Expression: Apache-2.0
+Project-URL: homepage, https://github.com/equinor/pyetp
+Classifier: Development Status :: 3 - Alpha
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numpy>=1.26.3
+Requires-Dist: websockets>=12.0
+Requires-Dist: lxml>=4.9.4
+Requires-Dist: pydantic>=1.10
+Requires-Dist: async-timeout>=5.0
+Requires-Dist: xtgeo>=4.0.0
+Requires-Dist: xsdata>=24.3.1
+Requires-Dist: etpproto>=1.0.7
+Dynamic: license-file
+
+![Build Status](https://github.com/equinor/pyetp/actions/workflows/ci.yml/badge.svg?branch=main)
+![codecov](https://codecov.io/gh/equinor/pyetp/graph/badge.svg?token=S2XDDKKI8U)
+![Python](https://img.shields.io/pypi/pyversions/pyetp)
+[![PyPI version](https://badge.fury.io/py/pyetp.svg)](https://badge.fury.io/py/pyetp)
+![License](https://img.shields.io/github/license/equinor/pyetp)
+
+# Installing the library
+This package is published to PyPI, and can be installed via:
+```bash
+pip install pyetp
+```
+
+## Local development
+Locally we suggest setting up a virtual environment, and installing the latest
+version of pip. Then install the library in editable mode along with the
+`dev`-dependency group. That is:
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install pip --upgrade
+pip install -e .
+pip install --group dev
+```
+
+
+## Linting and formatting
+We use ruff as a linter and formatter. To lint run:
+```bash
+ruff check
+```
+To run the formatter do:
+```bash
+ruff format
+```
+Or if you just want to check what could have been formatted:
+```bash
+ruff format --check
+```
+
+
+# RESQML versions
+The library is built and tested against RESQML v2.0.1. The spec can be
+downloaded
+[here](https://publications.opengroup.org/standards/energistics-standards/v231a).
+
+# Generated Python objects from RESQML spec
+Under `src/pyetp/resqml_objects` you will find Python objects generated from
+the RESQML xml spec.
+
+# Documentation
+See `/examples` for 2D grid usage
+
+`tests/test_mesh.py` for Unstructured/structured mesh
+
+# Running the unit tests
+We have set up unit tests against a local open-etp-server. To start this server
+run:
+```bash
+docker compose -f tests/compose.yml up [--detach]
+```
+If you want to re-use the same terminal window you should use the
+`--detach`-option, otherwise start a new terminal. We use `pytest` for testing,
+which can be run via:
+```bash
+py.test
+```
+
+# This library is under active development and subject to breaking changes

pyetp-0.0.43/README.md

@@ -0,0 +1,68 @@
+![Build Status](https://github.com/equinor/pyetp/actions/workflows/ci.yml/badge.svg?branch=main)
+![codecov](https://codecov.io/gh/equinor/pyetp/graph/badge.svg?token=S2XDDKKI8U)
+![Python](https://img.shields.io/pypi/pyversions/pyetp)
+[![PyPI version](https://badge.fury.io/py/pyetp.svg)](https://badge.fury.io/py/pyetp)
+![License](https://img.shields.io/github/license/equinor/pyetp)
+
+# Installing the library
+This package is published to PyPI, and can be installed via:
+```bash
+pip install pyetp
+```
+
+## Local development
+Locally we suggest setting up a virtual environment, and installing the latest
+version of pip. Then install the library in editable mode along with the
+`dev`-dependency group. That is:
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install pip --upgrade
+pip install -e .
+pip install --group dev
+```
+
+
+## Linting and formatting
+We use ruff as a linter and formatter. To lint run:
+```bash
+ruff check
+```
+To run the formatter do:
+```bash
+ruff format
+```
+Or if you just want to check what could have been formatted:
+```bash
+ruff format --check
+```
+
+
+# RESQML versions
+The library is built and tested against RESQML v2.0.1. The spec can be
+downloaded
+[here](https://publications.opengroup.org/standards/energistics-standards/v231a).
+
+# Generated Python objects from RESQML spec
+Under `src/pyetp/resqml_objects` you will find Python objects generated from
+the RESQML xml spec.
+
+# Documentation
+See `/examples` for 2D grid usage
+
+`tests/test_mesh.py` for Unstructured/structured mesh
+
+# Running the unit tests
+We have set up unit tests against a local open-etp-server. To start this server
+run:
+```bash
+docker compose -f tests/compose.yml up [--detach]
+```
+If you want to re-use the same terminal window you should use the
+`--detach`-option, otherwise start a new terminal. We use `pytest` for testing,
+which can be run via:
+```bash
+py.test
+```
+
+# This library is under active development and subject to breaking changes

pyetp-0.0.43/SECURITY.md

@@ -0,0 +1,17 @@
+If you discover a security vulnerability in this project, please follow these steps to responsibly disclose it:
+
+1. **Do not** create a public GitHub issue for the vulnerability.
+
+2. Follow our guideline for Responsible Disclosure Policy at https://www.equinor.com/about-us/csirt to report the issue
+
+
+The following information will help us triage your report more quickly:
+
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+- We prefer all communications to be in English.

pyetp-0.0.43/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools >= 80", "setuptools_scm[simple] >= 8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyetp"
+dynamic = ["version"]
+description = "Interface with OSDU RDDMS using ETP protocol"
+authors = [
+    {name = "Adam Cheng", email = "52572642+adamchengtkc@users.noreply.github.com"}
+]
+readme = "README.md"
+license = "Apache-2.0"
+classifiers = [
+  "Development Status :: 3 - Alpha",
+]
+dependencies = [
+    "numpy >= 1.26.3",
+    "websockets >= 12.0",
+    "lxml >=4.9.4",
+    "pydantic >= 1.10",
+    "async-timeout >= 5.0",
+    "xtgeo >= 4.0.0",
+    "xsdata >= 24.3.1",
+    "etpproto >= 1.0.7",
+]
+
+[project.urls]
+homepage = "https://github.com/equinor/pyetp"
+
+[dependency-groups]
+dev = [
+    "pytest >= 7.4.4",
+    "pytest-asyncio >= 0.23.4",
+    "fakeredis >= 2.21.0",
+    "pytest-cov >= 4.1.0",
+    "ipykernel >= 6.29.5",
+    "ruff>=0.13.2",
+]
+
+[tool.pytest.ini_options]
+addopts = "-ra -v --color=yes"
+testpaths = ["tests"]
+
+[tool.setuptools_scm]
+version_file = "src/pyetp/_version.py"
+
+[tool.ruff.lint]
+extend-select = [
+    "I", # isort
+]
+ignore = [
+    "E741", # Ignore ambigious variable name
+]
+
+[tool.ruff]
+exclude = ["*.ipynb", "venv", ".venv", "src/pyetp/types.py"]

pyetp-0.0.43/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyetp-0.0.43/src/pyetp/__init__.py

@@ -0,0 +1,12 @@
+from ._version import __version__
+from .client import ETPClient, ETPError, connect
+from .uri import DataObjectURI, DataspaceURI
+
+__all__ = [
+    "__version__",
+    "ETPClient",
+    "ETPError",
+    "connect",
+    "DataObjectURI",
+    "DataspaceURI",
+]

pyetp-0.0.43/src/pyetp/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.0.43'
+__version_tuple__ = version_tuple = (0, 0, 43)
+
+__commit_id__ = commit_id = 'g71591c6fb'