dt-extensions-sdk 1.7.4__tar.gz

dt_extensions_sdk-1.7.4/.github/workflows/build-package.yml

@@ -0,0 +1,40 @@
+name: Build distribution 📦
+
+on:
+  workflow_call:
+  workflow_dispatch:
+  pull_request:
+
+jobs:
+  build-package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install hatch
+        run: |
+          pip install hatch --user
+
+      - name: Run tests
+        run: |
+          python3 -m hatch run test
+
+      - name: Run linting
+        run: |
+          python3 -m hatch run lint:all
+
+      - name: Build a wheel and a source tarball
+        run: |
+          python3 -m hatch build
+      
+      - name: Upload built distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: package
+          path: dist/*
+

dt_extensions_sdk-1.7.4/.github/workflows/gh-pages-docs.yml

@@ -0,0 +1,76 @@
+name: Update Docs
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+
+      - name: Install hatch
+        run: |
+          pip install hatch
+
+      - name: Install dependencies
+        run: |
+          hatch env create
+
+      - name: Build the docs
+        run: |
+          hatch run docs:build 
+
+      - name: Cache built docs as artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: rendered-docs
+          path: |
+            docs/_build/**
+
+  upload-docs:
+    runs-on: ubuntu-latest
+    needs:
+      - build-docs
+
+    steps:
+      - name: Download built docs as cached artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: rendered-docs
+
+      - name: Change Git username for gh-pages branch
+        run: |
+          git config --global user.name "${GITHUB_ACTOR}"
+          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+
+      - name: Initialize gh-pages branch
+        run: |
+          git init
+          git remote add deploy "https://token:${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git"
+          git checkout -b gh-pages
+
+      - name: Add README disclaimer
+        run: |
+          echo '# GitHub Pages for `dt-extensions-sdk`' > README.md
+          echo "" >> README.md
+          echo "The contents of this branch are built using GitHub Actions workflow and Sphinx." >> README.md
+          echo "" >> README.md
+          echo "*commit ${GITHUB_SHA:0:6}*" >> README.md
+
+      - name: Add .nojekyll file to prevent the contents from being built by GitHub pages second time
+        run: |
+          touch .nojekyll
+
+      - name: Push everything to gh-pages branch on GitHub
+        run: |
+          git add .
+          git commit -m "📝 Rebuilt docs: commit ${GITHUB_SHA:0:6}"
+          git push deploy gh-pages --force

dt_extensions_sdk-1.7.4/.github/workflows/publish.yml

@@ -0,0 +1,87 @@
+name: Publish to PyPI
+on:
+  workflow_dispatch:
+
+jobs:  
+  check-tag:
+    runs-on: ubuntu-latest
+    steps:
+      - id: check_ref
+        run: echo "::set-output name=match::$(echo '${{ github.ref }}' | grep -Pq '^refs/tags/v\d+\.\d+\.\d+$' && echo true || echo false)"
+        shell: bash
+      - name: Check if tag is valid
+        if: steps.check_ref.outputs.match != 'true'
+        run: exit 1
+
+  build-package:
+    needs:
+      - check-tag
+    uses: ./.github/workflows/build-package.yml
+  
+  github-release:
+    name: Create GitHub release
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    needs:
+      - build-package
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Generate changelog
+        run: |
+          cat > CHANGELOG.md <<EOT
+          # CHANGELOG
+
+          **Release**: dt-cli (${GITHUB_REF#refs/tags/})
+
+          # Changes
+
+          EOT
+          
+          git log --format=format:"%ad: %s" --date=short >> CHANGELOG.md
+
+      - name: Download cached built package
+        uses: actions/download-artifact@v4
+        with:
+          name: package
+          path: dist
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            dist/*
+            LICENSE
+          body_path: CHANGELOG.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    needs:
+      - build-package
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install hatch
+        run: |
+          pip install hatch --user
+
+      - name: Download cached built package
+        uses: actions/download-artifact@v4
+        with:
+          name: package
+          path: dist
+
+      - name: Publish to PyPI
+        env:
+          PYPI_PUBLISH_TOKEN: ${{ secrets.PYPI_PUBLISH_TOKEN }}
+        run: |
+          hatch publish --user __token__ --auth $PYPI_PUBLISH_TOKEN --no-prompt

dt_extensions_sdk-1.7.4/.gitignore

@@ -0,0 +1,173 @@
+# Docs
+docs/_build
+docs/my_extension
+
+# 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/
+
+# VSCode
+.vscode/
+
+test_temp/
+
+# Thumbnails
+.DS_Store
+Thumb.db

dt_extensions_sdk-1.7.4/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023-present Dynatrace LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

dt_extensions_sdk-1.7.4/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: dt-extensions-sdk
+Version: 1.7.4
+Project-URL: Documentation, https://github.com/dynatrace-extensions/dt-extensions-python-sdk#readme
+Project-URL: Issues, https://github.com/dynatrace-extensions/dt-extensions-python-sdk/issues
+Project-URL: Source, https://github.com/dynatrace-extensions/dt-extensions-python-sdk
+Author-email: dlopes7 <davidribeirolopes@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: <3.11,>=3.10
+Provides-Extra: cli
+Requires-Dist: dt-cli>=1.6.13; extra == 'cli'
+Requires-Dist: pyyaml; extra == 'cli'
+Requires-Dist: ruff; extra == 'cli'
+Requires-Dist: typer[all]; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# Dynatrace Extensions Python SDK
+
+[![PyPI - Version](https://img.shields.io/pypi/v/dt-extensions-sdk.svg)](https://pypi.org/project/dt-extensions-sdk)
+[![PyPI - Python Version](https://img.shields.io/badge/python-3.10-blue)](https://img.shields.io/badge/python-3.10-blue)
+
+-----
+
+**Table of Contents**
+
+- [Quick Start](#quick-start)
+- [License](#license)
+- [Developing](#developing)
+
+## Documentation
+
+The documentation can be found on [github pages](https://dynatrace-extensions.github.io/dt-extensions-python-sdk/) 
+
+## Quick Start
+
+### Requirements:
+
+* Python 3.10
+
+### Install the SDK
+
+```bash
+pip install dt-extensions-sdk[cli]
+# Note, on some shells like zsh you may need to escape the brackets - pip install dt-extensions-sdk\[cli\]
+```
+
+### Create signing certificates
+
+```bash
+dt-sdk gencerts
+```
+
+### Create a new extension
+
+```bash
+dt-sdk create my_first_extension
+```
+
+### Simulate
+
+```bash
+cd my_first_extension
+dt-sdk run
+```
+
+### Build
+    
+```bash
+dt-sdk build
+```
+
+
+### Upload
+    
+```bash
+# Note, you need to either set environment variables DT_API_URL and DT_API_TOKEN or pass them as arguments
+dt-sdk upload
+```
+
+## Developing
+
+### Testing
+
+```console
+hatch run test
+```
+
+### Linting
+
+```console
+hatch run lint:all
+```
+
+### Building
+
+```console
+hatch build
+```
+
+### Building docs
+
+```console
+hatch run docs:build
+```
+
+## License
+
+`dt-extensions-sdk` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+
+
+## Publishing to PyPI
+
+It's automatically published to PyPi on each pushed tag, and uses [gh-action-pypi-publish](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/)
+Version will be determined using __about__.py

dt_extensions_sdk-1.7.4/README.md

@@ -0,0 +1,98 @@
+# Dynatrace Extensions Python SDK
+
+[![PyPI - Version](https://img.shields.io/pypi/v/dt-extensions-sdk.svg)](https://pypi.org/project/dt-extensions-sdk)
+[![PyPI - Python Version](https://img.shields.io/badge/python-3.10-blue)](https://img.shields.io/badge/python-3.10-blue)
+
+-----
+
+**Table of Contents**
+
+- [Quick Start](#quick-start)
+- [License](#license)
+- [Developing](#developing)
+
+## Documentation
+
+The documentation can be found on [github pages](https://dynatrace-extensions.github.io/dt-extensions-python-sdk/) 
+
+## Quick Start
+
+### Requirements:
+
+* Python 3.10
+
+### Install the SDK
+
+```bash
+pip install dt-extensions-sdk[cli]
+# Note, on some shells like zsh you may need to escape the brackets - pip install dt-extensions-sdk\[cli\]
+```
+
+### Create signing certificates
+
+```bash
+dt-sdk gencerts
+```
+
+### Create a new extension
+
+```bash
+dt-sdk create my_first_extension
+```
+
+### Simulate
+
+```bash
+cd my_first_extension
+dt-sdk run
+```
+
+### Build
+    
+```bash
+dt-sdk build
+```
+
+
+### Upload
+    
+```bash
+# Note, you need to either set environment variables DT_API_URL and DT_API_TOKEN or pass them as arguments
+dt-sdk upload
+```
+
+## Developing
+
+### Testing
+
+```console
+hatch run test
+```
+
+### Linting
+
+```console
+hatch run lint:all
+```
+
+### Building
+
+```console
+hatch build
+```
+
+### Building docs
+
+```console
+hatch run docs:build
+```
+
+## License
+
+`dt-extensions-sdk` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+
+
+## Publishing to PyPI
+
+It's automatically published to PyPi on each pushed tag, and uses [gh-action-pypi-publish](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/)
+Version will be determined using __about__.py

dt_extensions_sdk-1.7.4/docs/api/events/event_severity.rst

@@ -0,0 +1,13 @@
+Event Severity
+==============
+
+The :class:`Severity` class is used to define the severity of a log event.
+This enum can only be used in the context of a log ingestion when calling
+the :meth:`dynatrace_extension.Extension.report_event` method.
+
+Members
+^^^^^^^
+
+.. autoclass:: dynatrace_extension.Severity
+   :members:
+   :undoc-members:

dt_extensions_sdk-1.7.4/docs/api/events/event_type.rst

@@ -0,0 +1,14 @@
+Event Type
+==========
+
+The :class:`DtEventType` class is utilized to define the type event as
+ingested through the Events V2 API.
+This enum can only be used in the context of a event ingestion when
+calling the :meth:`dynatrace_extension.Extension.report_dt_event` method.
+
+Members
+^^^^^^^
+
+.. autoclass:: dynatrace_extension.DtEventType
+   :members:
+   :undoc-members:

dt_extensions_sdk-1.7.4/docs/api/events/index.rst

@@ -0,0 +1,9 @@
+Events
+======
+
+.. toctree::
+   :caption: Submodules and Classes
+   :maxdepth: 1
+
+   event_severity
+   event_type

dt_extensions_sdk-1.7.4/docs/api/extension.rst

@@ -0,0 +1,6 @@
+ pExtension
+=========
+
+.. autoclass:: dynatrace_extension.Extension
+   :members:
+   :undoc-members:

dt_extensions_sdk-1.7.4/docs/api/metrics/index.rst

@@ -0,0 +1,9 @@
+Metrics
+=======
+
+.. toctree::
+   :caption: Submodules and Classes
+   :maxdepth: 1
+
+   metric
+   metric_type