datatrail-cli 0.9.2__tar.gz → 0.10.0__tar.gz

datatrail_cli-0.10.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: tjzegmott
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Provide the steps to reproduce the bug.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+
+- OS: [e.g. MacOS]
+- Datatrail Version [e.g. 2.1.1, `datatrail version` output]
+
+**Additional context**
+Add any other context about the problem here.

datatrail_cli-0.10.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE]"
+labels: enhancement
+assignees: tjzegmott
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

datatrail_cli-0.10.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Related Issue
+<!--- This project only accepts pull requests related to open issues -->
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+
+## Screenshots (if appropriate):
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.

datatrail_cli-0.10.0/.github/workflows/continuous-deployment.yml

@@ -0,0 +1,48 @@
+on:
+  push:
+    branches:
+      - main
+name: Continuous Deployment
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create release
+        id: release-please
+        uses: google-github-actions/release-please-action@v3
+        with:
+          release-type: python
+          package-name: datatrail-cli
+
+      - name: Checkout code
+        if: ${{ steps.release-please.outputs.release_created }}
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 1
+
+      - name: Set up Python 3.13
+        if: ${{ steps.release-please.outputs.release_created }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.13
+
+      - name: Install poetry
+        if: ${{ steps.release-please.outputs.release_created }}
+        run: |
+          pip install --upgrade pip
+          pip install --upgrade poetry
+          poetry config virtualenvs.create true
+          poetry config virtualenvs.in-project false
+
+      - name: Install datatrail-cli
+        if: ${{ steps.release-please.outputs.release_created }}
+        run: |
+          poetry install
+
+      - name: Publish to pypi
+        if: ${{ steps.release-please.outputs.release_created }}
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          poetry config pypi-token.pypi $PYPI_TOKEN
+          poetry publish --build --verbose

datatrail_cli-0.10.0/.github/workflows/continuous-integration.yml

@@ -0,0 +1,104 @@
+name: Continuous Integration
+
+on:
+  push:
+    paths-ignore:
+      - "docs/**"
+    branches: [main]
+  pull_request:
+    paths-ignore:
+      - "docs/**"
+    branches:
+      - "**"
+
+jobs:
+  Pre-commit-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.13
+
+      - name: Linting
+        run: |
+          pip install pre-commit
+          pre-commit run --all-files
+
+  Testing:
+    needs: pre-commit-checks
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version:
+          - "3.9"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v5
+        with:
+          path: |
+            ~/.cache/pypoetry
+          key: poetry-${{ runner.os }}-${{ hashFiles('poetry.lock') }}
+
+      - name: Installation
+        run: |
+          pip install --upgrade pip
+          pip install poetry==2.1.2
+          pip install vos
+          poetry config virtualenvs.create true
+          poetry config virtualenvs.in-project false
+          poetry config cache-dir ~/.cache/pypoetry
+          poetry config virtualenvs.path ~/.cache/pypoetry/venv
+          poetry install --with dev
+
+      - name: Create NETRC file
+        run: |
+          export CANFAR_NETRC_FILE=$RUNNER_TEMP"/CANFAR_NETRC"
+          echo ${{ secrets.CANFAR_NETRC }} > $CANFAR_NETRC_FILE
+          echo CANFAR_NETRC_FILE=$CANFAR_NETRC_FILE >> "$GITHUB_ENV"
+
+      - name: Obtain CADC certificate
+        run: |
+          export CADC_CERT=$HOME"/.ssl/cadcproxy.pem"
+          cadc-get-cert --netrc-file ${{ env.CANFAR_NETRC_FILE }} --days-valid 1 --cert-filename $CADC_CERT
+          echo CADC_CERT=$CADC_CERT >> "$GITHUB_ENV"
+
+      - name: Run Tests
+        run: |
+          poetry run pytest tests/ --cov . --cov-report=lcov --cov-report=xml
+
+      - name: Remove NETRC file and CADC certificate
+        run: |
+          echo "Removing file: "$CANFAR_NETRC_FILE
+          rm $CANFAR_NETRC_FILE
+          echo "Removing file: "$CADC_CERT
+          rm $CADC_CERT
+
+      - name: Upload coverage to Coveralls
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: "coverage.lcov"
+          fail-on-error: false
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          fail_ci_if_error: false
+          token: ${{ secrets.CODECOV_TOKEN }}

datatrail_cli-0.10.0/.github/workflows/docs.yml

@@ -0,0 +1,20 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - ".github/workflows/docs.yml"
+
+jobs:
+  mkdocs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build chimefrb/handbook
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ secrets.BUILD_HANDBOOK_TOKEN }}
+          repository: chimefrb/handbook
+          event-type: build-handbook
+          client-payload: '{"source": "chimefrb/datatrail-cli"}'

datatrail_cli-0.10.0/.github/workflows/stale.yml

@@ -0,0 +1,21 @@
+name: Close Stale Issues and Pull Requests
+
+on:
+  schedule:
+    - cron: "0 0 * * *" # Run every day at midnight
+
+jobs:
+  close_stale_prs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Close stale pull requests
+        uses: actions/stale@v9
+        with:
+          days-before-stale: 90
+          days-before-close: 7
+          close-issue-message: "This pull request has been automatically closed. Please reopen if you feel this issue is still relevant."
+          stale-issue-message: "This pull request has been automatically marked as 'Stale' because it has been inactive for more than 90 days. If there is no interaction here, this issue will be closed in seven days."
+          stale-issue-label: Stale
+          close-pr-message: "This pull request has been automatically closed because it has been inactive for more than 90 days."
+          stale-pr-message: "This pull request has been marked as stale because it has been inactive for more than 90 days. Please update this pull request or it will be automatically closed in seven days."
+          stale-pr-label: Stale

datatrail_cli-0.10.0/.gitignore

@@ -0,0 +1,163 @@
+# 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
+
+# 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/
+
+# MacOS
+.DS_Store

datatrail_cli-0.10.0/.pre-commit-config.yaml

@@ -0,0 +1,96 @@
+repos:
+- hooks:
+  - args:
+    - --multi-line=3
+    - --trailing-comma
+    - --force-grid-wrap=0
+    - --use-parentheses
+    - --line-width=88
+    id: isort
+  repo: https://github.com/pycqa/isort
+  rev: 5.13.2
+- hooks:
+  - args:
+    - --max-line-length=89
+    - --max-complexity=15
+    id: flake8
+  repo: https://github.com/pycqa/flake8
+  rev: 7.0.0
+- hooks:
+  - args:
+    - --py36-plus
+    id: pyupgrade
+  repo: https://github.com/asottile/pyupgrade
+  rev: v3.15.0
+- hooks:
+  - id: black
+  repo: https://github.com/psf/black
+  rev: 23.3.0
+- hooks:
+  - additional_dependencies:
+    - types-attrs
+    - types-requests
+    - types-setuptools
+    - types-PyYAML
+    args:
+    - --ignore-missing-imports
+    - --no-implicit-optional
+    id: mypy
+  repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.8.0
+- hooks:
+  - args:
+    - --convention=google
+    - --add-ignore=D104
+    id: pydocstyle
+  repo: https://github.com/pycqa/pydocstyle
+  rev: 6.3.0
+- hooks:
+  - id: blacken-docs
+  repo: https://github.com/asottile/blacken-docs
+  rev: 1.16.0
+- hooks:
+  - exclude: ^docs/*
+    id: trailing-whitespace
+  - exclude: ^docs/*
+    id: end-of-file-fixer
+  - id: debug-statements
+  - id: check-case-conflict
+  - id: check-json
+  - args:
+    - --unsafe
+    id: check-yaml
+  - id: mixed-line-ending
+  - id: check-toml
+  - id: pretty-format-json
+  - id: check-docstring-first
+  - id: check-symlinks
+  - id: detect-private-key
+  repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+- hooks:
+  - args:
+    - -iii
+    - -lll
+    id: bandit
+  repo: https://github.com/PyCQA/bandit
+  rev: 1.7.6
+- hooks:
+  - additional_dependencies:
+    - radon
+    args:
+    - cc
+    - --min=C
+    - --total-average
+    entry: radon
+    id: radon
+    language: python
+    name: radon
+    verbose: true
+  repo: local
+- hooks:
+  - id: commitizen
+    stages:
+    - commit-msg
+  repo: https://github.com/commitizen-tools/commitizen
+  rev: v3.13.0