tts-utilities 0.3.2__tar.gz

tts_utilities-0.3.2/.gitignore

@@ -0,0 +1,188 @@
+# 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/
+pip-wheel-metadata/
+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/
+docsrc/_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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/
+
+env
+venv
+
+# IDEs and editors
+.idea/
+.vscode/
+*.sublime-project
+*.sublime-workspace
+
+# Jupyter notebooks
+.ipynb_checkpoints/
+
+# Jupyter lab workspace
+.jupyter/
+
+# Miscellaneous
+.DS_Store
+Thumbs.db
+._*
+
+# office tmp files
+~$*
+
+#nfs temp files
+.nfs*

tts_utilities-0.3.2/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: tts-utilities
+Version: 0.3.2
+Summary: A starter repo to help users quickly set up a Teamtools Studio project with common structure, configs, and package scaffolding.
+Author: shanemb
+Author-email: shanemb <shane.m.bonkowski@jpl.nasa.gov>, muszynsk <matt.muszynski@jpl.nasa.gov>
+License: Apache-2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: pytest
+Requires-Dist: tomli
+Requires-Dist: datetime
+Requires-Dist: rich
+Requires-Dist: ipynbname
+Requires-Dist: toml
+Requires-Dist: setuptools_scm
+Dynamic: author
+Dynamic: requires-python
+
+# Teamtools Studio Utilities
+
+![Project logo](https://github.com/NASA-JPL-Teamtools-Studio/teamtools-documentation/blob/main/docs/images/tts_image_artifacts/tts_utilities.png)
+
+## About Teamtools Studio
+
+Teamtools Studio Utilities is part of JPL's Teamtools Studio (TTS).
+
+TTS is an effort originated in JPL's Planning and Execution section to centralize shared repositories across missions. This benefits JPL by reducing cost through reducing duplicated code, collaborating across missions, and unifying standards for development and design across JPL.
+
+Although Planning and Execution is primarily concerned with flight operations, the TTS suite has been generalized and atomized to the point where many of these tools are applicable during other mission phases and even in non-spaceflight contexts. Through our work flying space missions, we hope to provide tools to the open source community that have utility in data analysis or planning for any complex system where failure is not an option.
+
+For more infomation on how to contribute, and how these libraries form a complete ecosystem for high reliability data analysis, see the [Full TTS Documentation](https://github.com/NASA-JPL-Teamtools-Studio/teamtools-documentation/).
+
+## What is Teamtools Studio Utilities?
+
+### Overview
+
+Teamtools Studio Utilities is a helper library to improve the quality of life of Teamtools Studio developers. It is
+required by all Teamtools Studio libraries in order to support versions of Python back to 3.6 while still using a modern
+method of packaging. All TTS libraries include both a pyproject.toml and setup.py file, but only the pyproject.toml is
+a source of truth. setup.py only calls a utility from this library to convert the information in the toml file into the
+Pythonic format expected by Python versions prior to 3.8.
+
+The most important thing here for most developrs is the common TTS logger.
+
+### Projects Currently Supported
+
+* Europa Clipper
+* Mars 2020/Perseverance
+* Mars Sample Return/Sample Retrieval Lander
+* Mars Science Laboratory/Curiosity
+* Mars Reconnaisance Orbiter
+* NISAR
+* Orbiting Carbon Observatory 2 (OCO-2)
+
+## Architecture
+
+### TTS dependencies
+
+* None

tts_utilities-0.3.2/README.md

@@ -0,0 +1,41 @@
+# Teamtools Studio Utilities
+
+![Project logo](https://github.com/NASA-JPL-Teamtools-Studio/teamtools-documentation/blob/main/docs/images/tts_image_artifacts/tts_utilities.png)
+
+## About Teamtools Studio
+
+Teamtools Studio Utilities is part of JPL's Teamtools Studio (TTS).
+
+TTS is an effort originated in JPL's Planning and Execution section to centralize shared repositories across missions. This benefits JPL by reducing cost through reducing duplicated code, collaborating across missions, and unifying standards for development and design across JPL.
+
+Although Planning and Execution is primarily concerned with flight operations, the TTS suite has been generalized and atomized to the point where many of these tools are applicable during other mission phases and even in non-spaceflight contexts. Through our work flying space missions, we hope to provide tools to the open source community that have utility in data analysis or planning for any complex system where failure is not an option.
+
+For more infomation on how to contribute, and how these libraries form a complete ecosystem for high reliability data analysis, see the [Full TTS Documentation](https://github.com/NASA-JPL-Teamtools-Studio/teamtools-documentation/).
+
+## What is Teamtools Studio Utilities?
+
+### Overview
+
+Teamtools Studio Utilities is a helper library to improve the quality of life of Teamtools Studio developers. It is
+required by all Teamtools Studio libraries in order to support versions of Python back to 3.6 while still using a modern
+method of packaging. All TTS libraries include both a pyproject.toml and setup.py file, but only the pyproject.toml is
+a source of truth. setup.py only calls a utility from this library to convert the information in the toml file into the
+Pythonic format expected by Python versions prior to 3.8.
+
+The most important thing here for most developrs is the common TTS logger.
+
+### Projects Currently Supported
+
+* Europa Clipper
+* Mars 2020/Perseverance
+* Mars Sample Return/Sample Retrieval Lander
+* Mars Science Laboratory/Curiosity
+* Mars Reconnaisance Orbiter
+* NISAR
+* Orbiting Carbon Observatory 2 (OCO-2)
+
+## Architecture
+
+### TTS dependencies
+
+* None

tts_utilities-0.3.2/ci/sphinx_ignore_tags.txt

@@ -0,0 +1,19 @@
+#When tts-build-sphinx-docs runs, it will collect all tags and branches and attempt to build
+#docs for each in the gh-pages branch. This is a config file that allows developers to 
+#specifically exclude any branches or tags they need. Each line is the name of a tag or 
+#branch.
+#
+#This file makes no attemtpt to tell whether a line is a tag or a branch as TTS assumes that
+#the naming conventions will always be different, and that tags should be tied to releases,
+#so they should always have semvar names, whereas branches should be more descriptive using
+#typical agile branch naming conventions.
+#
+#The most typical use case is to exclude tags that were created before you added the docs
+#prerequisites, or to exclude the gh-pages branch itself since no code is expected to live
+#there. All TTS repos are expected to have a gh-pages branch, but it is expected that it
+#will always be managed by tts-build-sphinx-docs. You do not need to manually create
+#a gh-pages branch because tts-build-sphinx-docs will create one if it does not exist.
+#
+#tts-build-sphinx-docs will also always remove all files from gh-pages and rebuild all docs
+#from scratch
+gh-pages

tts_utilities-0.3.2/docs/_static/bugfix.css

@@ -0,0 +1,12 @@
+/*
+Resolves a bug where the text in the header
+"[package name] [package version] documentation"
+was getting stacked up on top of itself when the variable portions were too long. Something with floats
+and elements not taking up the whole width of their contents.
+
+Needed to add it because setuptools-scm version names can be very long, especially for versions that
+are build off of a commit with no tag
+*/
+.navbar-header-items__start {
+    width: auto;
+}

tts_utilities-0.3.2/docs/conf.py

@@ -0,0 +1,71 @@
+# TTS-specifc add ons
+from pathlib import Path
+from datetime import datetime
+from setuptools_scm import get_version
+import toml
+
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+
+import os
+import sys
+import importlib.metadata
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- Project information -----------------------------------------------------
+
+pyproject = toml.load(Path(__file__).parent.parent.joinpath("pyproject.toml"))
+project = pyproject["project"]["name"]
+release = get_version(root='..', relative_to=__file__)
+version = '.'.join(release.split('.')[:2])
+
+copyright = f'{datetime.now().strftime('%Y')} JPL'
+author = 'JPL Teamtools Studio'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The master toctree document.
+master_doc = 'index'
+
+pygments_style = 'sphinx'
+# html_theme = 'nature'
+# html_theme = 'sphinx_material'
+html_theme = 'pydata_sphinx_theme'
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+html_css_files = ['bugfix.css']
+html_copy_source = False
+html_show_sourcelink = False

tts_utilities-0.3.2/docs/index.rst

@@ -0,0 +1,18 @@
+Welcome to the Teamtools Starter Template documentation!
+=============================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   logger
+   util
+   setup_from_pyproject
+   test_utilities
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

tts_utilities-0.3.2/docs/logger.rst

@@ -0,0 +1,5 @@
+Logger
+===============
+
+.. automodule:: tts_utilities.logger
+   :members:

tts_utilities-0.3.2/docs/setup_from_pyproject.rst

@@ -0,0 +1,5 @@
+Setup from Pyproject
+=====================
+
+.. automodule:: tts_utilities.setup_from_pyproject
+   :members:

tts_utilities-0.3.2/docs/test_utilities.rst

@@ -0,0 +1,5 @@
+Test Utilities
+===============
+
+.. automodule:: tts_utilities.test_utilities
+   :members:

tts_utilities-0.3.2/docs/util.rst

@@ -0,0 +1,5 @@
+Util
+===============
+
+.. automodule:: tts_utilities.util
+   :members:

tts_utilities-0.3.2/license.md

@@ -0,0 +1,14 @@
+Copyright (c) 2025 California Institute of Technology (Caltech). U.S. Government sponsorship acknowledged.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+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.
+Neither the name of Caltech nor its operating division, the Jet Propulsion Laboratory, 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 OWNER 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. Open Source License Approved by Caltech/JPL APACHE LICENSE, VERSION 2.0
+
+Text version: https://www.apache.org/licenses/LICENSE-2.0.txt
+SPDX short identifier: Apache-2.0
+OSI Approved License: https://opensource.org/licenses/Apache-2.0

tts_utilities-0.3.2/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "tts-utilities"
+description = "A starter repo to help users quickly set up a Teamtools Studio project with common structure, configs, and package scaffolding."
+readme = "README.md"
+requires-python = ">=3.6"
+license = {text = "Apache-2.0"}
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+]
+authors = [
+  { name = "shanemb", email = "shane.m.bonkowski@jpl.nasa.gov" },
+  { name = "muszynsk", email = "matt.muszynski@jpl.nasa.gov" },
+]
+dependencies = [
+  "pytest", 
+  "tomli", 
+  "datetime",
+  "rich",
+  "ipynbname",
+  "toml",
+  "setuptools_scm"
+]
+dynamic = ["version"]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools_scm]
+version_scheme = "guess-next-dev"
+local_scheme = "no-local-version"
+
+[build-system]
+requires = [
+    "setuptools", 
+    "setuptools_scm",
+    "toml", 
+    "wheel", 
+    ]
+build-backend = "setuptools.build_meta"

tts_utilities-0.3.2/setup.cfg

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

tts_utilities-0.3.2/setup.py

@@ -0,0 +1,17 @@
+#Helper file to support installing locally on older Python systems
+#once we can move 100% to a system like pyproject.toml or poetry
+#we can ditch this file and setup_from_pyproject. But as long
+#as we have missions on 3.6.4, we should keep it in place so
+#we can dev locally on those projects and install this locally
+import os
+import sys
+
+# Add src/ to sys.path so the package can be found.
+# this is a special need for tts-deployments only. 
+# don't copy this line into other repos. Those other repos
+# require tts-deployments as a build dependency, but 
+# tts-deployments can't require itself, so we have to 
+# import it locally like this at build time.
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "src"))
+from tts_utilities.setup_from_pyproject import setup_from_pyproject
+setup_from_pyproject()