pyrecap 0.0.1a0__tar.gz

pyrecap-0.0.1a0/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

pyrecap-0.0.1a0/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Maintainer
+----------
+
+* Venkateswaran Shekar (Brookhaven National Lab) <vshekar1@bnl.gov>
+
+Contributors
+------------
+
+None yet. Why not be the first? See: CONTRIBUTING.rst

pyrecap-0.0.1a0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Brookhaven National Lab
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pyrecap-0.0.1a0/LICENSE_README

@@ -0,0 +1,5 @@
+The Software resulted from work developed under a U.S. Government Contract No. DE-SC0012704 and are subject to the following terms:  the U.S. Government is granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable worldwide license in this computer software and data to reproduce, prepare derivative works, and perform publicly and display publicly.
+ 
+THE SOFTWARE IS SUPPLIED "AS IS" WITHOUT WARRANTY OF ANY KIND. THE UNITED STATES, THE UNITED STATES DEPARTMENT OF ENERGY, AND THEIR EMPLOYEES: (1) DISCLAIM ANY WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NON-INFRINGEMENT, (2) DO NOT ASSUME ANY LEGAL LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF THE SOFTWARE, (3) DO NOT REPRESENT THAT USE OF THE SOFTWARE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS, (4) DO NOT WARRANT THAT THE SOFTWARE WILL FUNCTION UNINTERRUPTED, THAT IT IS ERROR-FREE OR THAT ANY ERRORS WILL BE CORRECTED.
+ 
+IN NO EVENT SHALL THE UNITED STATES, THE UNITED STATES DEPARTMENT OF ENERGY, OR THEIR EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, SPECIAL OR PUNITIVE DAMAGES OF ANY KIND OR NATURE RESULTING FROM EXERCISE OF THIS LICENSE AGREEMENT OR THE USE OF THE SOFTWARE.

pyrecap-0.0.1a0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: pyrecap
+Version: 0.0.1a0
+Summary: Scientific framework for Reproducible Experiment Capture and Provenance
+Author-email: Venkateswaran Shekar <vshekar1@bnl.gov>
+License: BSD-3-Clause
+License-File: AUTHORS.rst
+License-File: LICENSE
+License-File: LICENSE_README
+Keywords: experiments,provenance,reproducibility
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Requires-Dist: pydantic>=2.0
+Requires-Dist: python-slugify
+Requires-Dist: sqlalchemy>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Description-Content-Type: text/x-rst
+
+======================================================
+RECAP (Reproducible Experiment Capture and Provenance)
+======================================================
+
+.. image:: https://github.com/NSLS2/recap/actions/workflows/testing.yml/badge.svg
+   :target: https://github.com/NSLS2/recap/actions/workflows/testing.yml
+
+
+.. image:: https://img.shields.io/pypi/v/recap.svg
+        :target: https://pypi.python.org/pypi/pyrecap
+
+
+A scientific framework for Reproducible Experiment Capture, tracking, and metadata management
+
+* Free software: 3-clause BSD license
+* Documentation: (COMING SOON!) 
+
+Features
+--------
+
+* TODO

pyrecap-0.0.1a0/README.rst

@@ -0,0 +1,21 @@
+======================================================
+RECAP (Reproducible Experiment Capture and Provenance)
+======================================================
+
+.. image:: https://github.com/NSLS2/recap/actions/workflows/testing.yml/badge.svg
+   :target: https://github.com/NSLS2/recap/actions/workflows/testing.yml
+
+
+.. image:: https://img.shields.io/pypi/v/recap.svg
+        :target: https://pypi.python.org/pypi/pyrecap
+
+
+A scientific framework for Reproducible Experiment Capture, tracking, and metadata management
+
+* Free software: 3-clause BSD license
+* Documentation: (COMING SOON!) 
+
+Features
+--------
+
+* TODO

pyrecap-0.0.1a0/pyproject.toml

@@ -0,0 +1,90 @@
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyrecap"
+dynamic = ["version"]
+description = "Scientific framework for Reproducible Experiment Capture and Provenance"
+authors = [{ name = "Venkateswaran Shekar", email = "vshekar1@bnl.gov" }]
+requires-python = ">=3.8"
+readme = "README.rst"
+license = { text = "BSD-3-Clause" }
+dependencies = [
+    "sqlalchemy>=2.0",
+    "pydantic>=2.0",
+    "python-slugify"
+]
+
+keywords = ["experiments", "provenance", "reproducibility"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent"
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest"
+]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "recap/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["recap"]
+
+[tool.hatch.build]
+include = [
+    "recap/**",
+    "README.rst",
+    "LICENSE*"
+]
+
+[tool.black]
+line-length = 115
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+
+  # The following are specific to Black, you probably don't want those.
+  | blib2to3
+  | tests/data
+)/
+'''
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "SIM", "C90"]
+ignore = ["E203", "E501"]  # Black-style formatting norms
+
+[tool.ruff.lint.per-file-ignores]
+"**/versioneer.py" = ["ALL"]
+"**/_version.py" = ["ALL"]
+"**/setup.py" = ["ALL"]
+"**/docs/**" = ["ALL"]
+
+[tool.ruff.lint.isort]
+known-first-party = []
+

pyrecap-0.0.1a0/recap/__init__.py

@@ -0,0 +1,4 @@
+from ._version import get_versions
+
+__version__ = get_versions()["version"]
+del get_versions

pyrecap-0.0.1a0/recap/_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.1a0'
+__version_tuple__ = version_tuple = (0, 0, 1, 'a0')
+
+__commit_id__ = commit_id = None

pyrecap-0.0.1a0/recap/client/base_client.py

@@ -0,0 +1,46 @@
+from contextlib import contextmanager
+
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+
+from recap.dsl.process_builder import ProcessRunBuilder, ProcessTemplateBuilder
+from recap.dsl.resource_builder import ResourceTemplateBuilder
+
+
+class RecapClient:
+    def __init__(self, url: str | None = None, echo: bool = False, session=None):
+        if url is not None:
+            self.engine = create_engine(url, echo=echo)
+            self.Session = sessionmaker(
+                bind=self.engine, expire_on_commit=False, future=True
+            )
+        if session is not None:
+            self._session = session
+
+    @contextmanager
+    def session(self):
+        """Yield a Session with transaction boundaries."""
+        with self.Session() as session:
+            try:
+                with session.begin():
+                    yield session
+            finally:
+                # Session closed by context exit
+                ...
+
+    def process_template(self, name: str, version: str) -> ProcessTemplateBuilder:
+        session = self._session
+        return ProcessTemplateBuilder(session=session, name=name, version=version)
+
+    def process_run(self, name: str, template_name: str, version: str):
+        return ProcessRunBuilder(
+            session=self._session,
+            name=name,
+            template_name=template_name,
+            version=version,
+        )
+
+    def resource_template(self, name: str, type_names: list[str]):
+        return ResourceTemplateBuilder(
+            session=self._session, name=name, type_names=type_names
+        )