sammi-cdf 0.1.1__tar.gz

sammi_cdf-0.1.1/.devcontainer/devcontainer.json

@@ -0,0 +1,74 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.183.0/containers/python-3
+{
+	"name": "Ubuntu 20.04 Python 3",
+	// Repo where this image's Dockerfile is maintained: https://github.com/HERMES-SOC/docker-lambda-base
+	"image": "public.ecr.aws/w5r9l1c8/dev-swsoc-docker-lambda-base:latest",
+	"initializeCommand": "docker logout public.ecr.aws && docker pull public.ecr.aws/w5r9l1c8/dev-swsoc-docker-lambda-base:latest",
+	// If you want to run the production version of the container, comment out the image and initializeCommand lines above and uncomment the line below.
+	// "image": "public.ecr.aws/w5r9l1c8/swsoc-docker-lambda-base:latest",
+	// "initializeCommand": "docker logout public.ecr.aws && docker pull public.ecr.aws/w5r9l1c8/swsoc-docker-lambda-base:latest",
+	"customizations": {
+		"vscode": {
+			// Set *default* container specific settings.json values on container create.
+			"settings": {
+				"python.pythonPath": "/usr/bin/python3",
+				"python.testing.unittestEnabled": false,
+				"python.testing.pytestEnabled": true,
+				"python.languageServer": "Pylance",
+				//PyLint Settings
+				"pylint.enabled": true,
+				"pylint.path": [
+					"/usr/bin/pylint"
+				],
+				"pylint.lintOnChange": true,
+				// Black Settings
+				"python.editor.defaultFormatter": "ms-python.black-formatter",
+				"python.editor.formatOnSave": true,
+				"black-formatter.path": [
+					"/usr/local/bin/black"
+				],
+				"black-formatter.args": [
+					"--line-length",
+					"100"
+				],
+				// Flake8 Settings
+				"flake8.path": [
+					"/usr/local/bin/flake8"
+				],
+				"flake8.lintOnChange": true,
+				// Terminal Settings
+				"terminal.integrated.defaultProfile.linux": "bash (login)",
+				"terminal.integrated.profiles.linux": {
+					"bash (login)": {
+						"path": "bash"
+					}
+				}
+			},
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"ms-python.python",
+				"ms-python.vscode-pylance",
+				"ms-python.pylint",
+				"ms-python.black-formatter",
+				"ms-python.flake8",
+				"marklarah.pre-commit-vscode",
+				"ms-toolsai.jupyter",
+				"ms-toolsai.jupyter-renderers",
+				"ms-toolsai.jupyter-keymap",
+				"jithurjacob.nbpreviewer"
+			],
+		}
+	},
+	// Mount to a volume if you'd like to persist data to your disk
+	"mounts": [
+		// Mounds your local bach_profile to the container's bashrc
+		"source=${localEnv:HOME}/.bash_profile,target=/home/vscode/.bashrc,type=bind,consistency=cached"
+	],
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// package is uninstalled from the container image after it is created to avoid circular import errors during development
+	"postCreateCommand": "sudo pip3 uninstall sammi -y",
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+}

sammi_cdf-0.1.1/.github/workflows/codestyle.yml

@@ -0,0 +1,40 @@
+# This workflow will install Python dependencies, run tests, run linting, and test building docs
+name: Codestyle and Linting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch: # For on demand runs
+  schedule:
+    - cron: 0 0 * * * # Scheduled run every day at midnight
+jobs:
+  build:
+
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest]
+        python-version: [3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip install pip setuptools wheel --upgrade
+        python -m pip install -e '.[style]'
+    - name: Lint with Black
+      run: |
+        black --check --diff sammi
+    - name: flake8
+      run: |
+        flake8 --count sammi
+

sammi_cdf-0.1.1/.github/workflows/docs.yml

@@ -0,0 +1,35 @@
+# This workflow will install Python dependencies, run tests, run linting, and build docs
+name: Building Docs
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch: # For on demand runs
+  schedule:
+    - cron: 0 0 * * * # Scheduled run every day at midnight
+jobs:
+  build:
+
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest]
+        python-version: [3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: rstcheck
+      run: |
+        pip install -e .[style,docs,all]
+        rstcheck -r docs 
+    - name: Build docs
+      run: sphinx-build docs docs/_build/html -W -b html

sammi_cdf-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,69 @@
+name: Build and upload to PyPI
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
+  cancel-in-progress: true
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    outputs:
+      SDIST_NAME: ${{ steps.sdist.outputs.SDIST_NAME }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # We need the full history to generate the proper version number
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v4
+        name: Install Python
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: python -m pip install build twine
+
+      - name: Build sdist
+        id: sdist
+        run: |
+          python -m build --sdist
+          # Get the name of the build sdist file for later use
+          echo "SDIST_NAME=$(ls -1 dist)" >> $GITHUB_OUTPUT
+
+      - name: Check README rendering for PyPI
+        run: twine check dist/*
+
+      - name: Upload sdist result
+        uses: actions/upload-artifact@v3
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+          if-no-files-found: error
+
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    needs: build_sdist
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sammi-cdf
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+    steps:
+      - name: Download sdist
+        uses: actions/download-artifact@v3
+        with:
+          name: sdist
+          path: dist
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.8.10

sammi_cdf-0.1.1/.github/workflows/testing.yml

@@ -0,0 +1,44 @@
+# This workflow will install Python dependencies, run tests, run linting, and test building docs
+name: Testing
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch: # For on demand runs
+  schedule:
+    - cron: 0 0 * * * # Scheduled run every day at midnight
+jobs:
+  build:
+
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.9, '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        pip install pip setuptools wheel --upgrade
+        pip install -e .[test]
+
+    - name: Run Tests
+      run: pytest --pyargs sammi --cov sammi
+      env:
+        PLATFORM: ${{ matrix.platform }}
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v4.0.1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

sammi_cdf-0.1.1/.gitignore

@@ -0,0 +1,144 @@
+# 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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*.ipynb
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pylint / pyreverse
+*.dot
+*.png
+
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.vscode
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+swxschema/version.py
+
+# Mac hidden files
+.DS_Store
+
+# files generated by sphinx
+docs/generated
+
+_version.py

sammi_cdf-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+exclude: '.git|.tox'
+
+repos:
+  # The warnings/errors we check for here are:
+  # E101 - mix of tabs and spaces
+  # W191 - use of tabs
+  # W291 - trailing whitespace
+  # W292 - no newline at end of file
+  # W293 - trailing whitespace
+  # W391 - blank line at end of file
+  # E111 - 4 spaces per indentation level
+  # E112 - 4 spaces per indentation level
+  # E113 - 4 spaces per indentation level
+  # E303 - too many blank lines (3)
+  # E304 - blank lines found after function decorator
+  # E305 - expected 2 blank lines after class or function definition
+  # E306 - expected 1 blank line before a nested definition
+  # E502 - the backslash is redundant between brackets
+  # E722 - do not use bare except
+  # E901 - SyntaxError or IndentationError
+  # E902 - IOError
+  # F822: undefined name in __all__
+  # F823: local variable name referenced before assignment
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+        args: ['--count', '--select', 'E101,E11,E111,E112,E113,E121,E122,E123,E124,E125,E126,E127,E128,E129,E131,E133,E20,E211,E231,E241,E242,E251,E252,E26,E265,E266,E27,E301,E302,E303,E304,E305,E306,E401,E402,E502,E701,E711,E712,E713,E714,E722,E731,E901,E902,F822,F823,W191,W291,W292,W293,W391,W601,W602,W603,W604,W605,W690']
+
+  - repo: https://github.com/psf/black
+    rev: 24.1.1
+    hooks:
+      - id: black
+
+  - repo: https://github.com/rstcheck/rstcheck
+    rev: v6.2.0
+    hooks:
+    -   id: rstcheck
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.4.0
+    hooks:
+      - id: check-ast
+      - id: check-case-conflict
+      - id: trailing-whitespace
+        exclude: ".*(.fits|.fts|.fit|.txt)$"
+      - id: check-yaml
+      - id: debug-statements
+      - id: check-added-large-files
+#      - id: end-of-file-fixer uncommenting this will break the testing of the cookiecutter template
+#        exclude: ".*(.fits|.fts|.fit|.txt|tca.*)$"
+      - id: mixed-line-ending
+        exclude: ".*(.fits|.fts|.fit|.txt|tca.*)$"

sammi_cdf-0.1.1/.readthedocs.yml

@@ -0,0 +1,31 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+  jobs:
+    pre_build:
+      - pip install pip setuptools wheel --upgrade
+      - pip install -e .[docs,all]
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+  - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#     - method: pip
+#       path: .
+#       extra_requirements:
+#         - docs
+#         - all

sammi_cdf-0.1.1/CHANGELOG.rst

@@ -0,0 +1,11 @@
+This project uses `semantic versioning <https://semver.org>`_.
+
+Latest
+======
+* Added Functionality from HERMES partner package. 
+
+0.0.0 (2023-03-22)
+==================
+Initial project release 
+
+- Initial Release 

sammi_cdf-0.1.1/LICENSE.rst

@@ -0,0 +1 @@
+see licenses/LICENSE.md

sammi_cdf-0.1.1/MANIFEST.in

@@ -0,0 +1,17 @@
+include README.rst
+include CHANGES.rst
+include setup.cfg
+include LICENSE.rst
+include pyproject.toml
+
+recursive-include swxschema *.pyx *.c *.pxd
+recursive-include docs *
+recursive-include licenses *
+recursive-include cextern *
+recursive-include scripts *
+
+prune build
+prune docs/_build
+prune docs/api
+
+global-exclude *.pyc *.o

sammi_cdf-0.1.1/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.1
+Name: sammi-cdf
+Version: 0.1.1
+Summary: A Python package to support metadata attriubte management for Space Weather data processing pipelines.
+Author-email: Andrew Robbertz <a.robbertz@gmail.com>, IMAP SDC Developers <imap.sdc@lists.lasp.colorado.edu>
+License: see licenses/LICENSE.md
+Project-URL: Homepage, https://github.com/swxsoc/sammi
+Keywords: sammi,nasa mission,space weather
+Classifier: Development Status :: 3 - Alpha
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+Requires-Dist: pyyaml>=5.3.1
+Provides-Extra: dev
+Requires-Dist: coverage>=5.0.3; extra == "dev"
+Requires-Dist: pytest==8.0.0; extra == "dev"
+Requires-Dist: pytest-astropy==0.11.0; extra == "dev"
+Requires-Dist: pytest-cov==4.1.0; extra == "dev"
+Requires-Dist: black==24.1.1; extra == "dev"
+Requires-Dist: flake8==7.0.0; extra == "dev"
+Requires-Dist: coverage[toml]==7.4.1; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx==7.2.6; extra == "docs"
+Requires-Dist: sphinx-automodapi==0.16.0; extra == "docs"
+Requires-Dist: sphinx-copybutton==0.5.2; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest==8.0.0; extra == "test"
+Requires-Dist: pytest-astropy==0.11.0; extra == "test"
+Requires-Dist: pytest-cov==4.1.0; extra == "test"
+Requires-Dist: coverage[toml]==7.4.1; extra == "test"
+Provides-Extra: style
+Requires-Dist: black==24.1.1; extra == "style"
+Requires-Dist: flake8==7.0.0; extra == "style"
+Requires-Dist: rstcheck==6.2.0; extra == "style"
+
+========
+Overview
+========
+
+SAMMI (Shared Attribute and Metadata Management Interface) is a python package that provides a schema for metadata attributes within space weather data products.
+This package is a SWxSOC project and can be used in conjunction with other SWxSOC projects, or as a standalone package. 
+
+.. start-badges
+
+.. list-table::
+    :stub-columns: 1
+
+    * - docs
+      - |docs| |readthedocs|
+    * - build status
+      - |testing| |codestyle| |coverage|
+
+.. |docs| image:: https://github.com/swxsoc/swxschema/actions/workflows/docs.yml/badge.svg
+    :target: https://github.com/swxsoc/swxschema/actions/workflows/docs.yml
+    :alt: Documentation Build Status
+
+.. |testing| image:: https://github.com/swxsoc/swxschema/actions/workflows/testing.yml/badge.svg
+    :target: https://github.com/swxsoc/swxschema/actions/workflows/testing.yml
+    :alt: Build Status
+
+.. |codestyle| image:: https://github.com/swxsoc/swxschema/actions/workflows/codestyle.yml/badge.svg
+    :target: https://github.com/swxsoc/swxschema/actions/workflows/codestyle.yml
+    :alt: Codestyle and linting using flake8
+
+.. |coverage| image:: https://codecov.io/gh/swxsoc/swxschema/branch/main/graph/badge.svg?token=C6JLIWZRBU 
+    :target: https://codecov.io/gh/swxsoc/swxschema
+    :alt: Testing coverage
+
+.. |readthedocs| image:: https://readthedocs.org/projects/swxschema/badge/?version=latest
+    :target: https://swxschema.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. end-badges
+
+Documentation
+-------------
+The documentation is hosted on readthedocs and is available `here <https://swxschema.readthedocs.io/en/latest/>`_.
+
+License
+-------
+
+See the license/LICENSE file for more information.
+
+
+Contributing
+------------
+
+We love contributions! This project is open source,
+built on open source, and we'd love to have you hang out in our community.
+
+**Imposter syndrome disclaimer**: We want your help. No, really.
+
+There may be a little voice inside your head that is telling you that you're not
+ready to be an open source contributor; that your skills aren't nearly good
+enough to contribute. What could you possibly offer a project like this one?
+
+We assure you - the little voice in your head is wrong. If you can write code at
+all, you can contribute code to open source. Contributing to open source
+projects is a fantastic way to advance one's coding skills. Writing perfect code
+isn't the measure of a good developer (that would disqualify all of us!); it's
+trying to create something, making mistakes, and learning from those
+mistakes. That's how we all improve, and we are happy to help others learn.
+
+Being an open source contributor doesn't just mean writing code, either. You can
+help out by writing documentation, tests, or even giving feedback about the
+project (and yes - that includes giving feedback about the contribution
+process). Some of these contributions may be the most valuable to the project as
+a whole, because you're coming to the project with fresh eyes, so you can see
+the errors and assumptions that seasoned contributors have glossed over.
+
+Note: This disclaimer was originally written by
+`Adrienne Lowe <https://github.com/adriennefriend>`_ for a
+`PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`_, and was adapted by
+by this project based on its use in the README file for the
+`MetPy project <https://github.com/Unidata/MetPy>`_.
+
+Code of Conduct
+---------------
+When you are interacting with the SWxSOC community you are asked to follow
+our `Code of Conduct <https://github.com/swxsoc/code-of-conduct/blob/main/CODE_OF_CONDUCT.md>`_.
+
+Acknowledgements
+----------------
+The package template used by this package is based on the one developed by the
+`OpenAstronomy community <https://openastronomy.org>`_ and the `SunPy Project <https://sunpy.org/>`_.
+
+Public Domain
+-------------
+
+This project constitutes a work of the United States Government and is not subject to domestic copyright protection under `17 USC § 105 <https://www.govinfo.gov/app/details/USCODE-2010-title17/USCODE-2010-title17-chap1-sec105>`__. Additionally, we waive copyright and related rights in the work worldwide through the `CC0 1.0 Universal public domain dedication <https://creativecommons.org/publicdomain/zero/1.0/>`__.
+
+All contributions to this project will be released under the CC0
+dedication. By submitting a pull request, you are agreeing to comply
+with this waiver of copyright interest.