dt-extensions-sdk 1.1.0__tar.gz → 1.1.1__tar.gz

dt_extensions_sdk-1.1.1/.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.1.0 → dt_extensions_sdk-1.1.1}/.gitignore

@@ -1,3 +1,7 @@
+# Docs
+docs/_build
+docs/my_extension
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -85,7 +89,7 @@ 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
+.python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -159,4 +163,8 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
-test_temp/
+test_temp/
+
+# Thumbnails
+.DS_Store
+Thumb.db

{dt_extensions_sdk-1.1.0 → dt_extensions_sdk-1.1.1}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: dt-extensions-sdk
-Version: 1.1.0
-Project-URL: Documentation, https://github.com/unknown/dynatrace-extensions-sdk#readme
-Project-URL: Issues, https://github.com/unknown/dynatrace-extensions-sdk/issues
-Project-URL: Source, https://github.com/unknown/dynatrace-extensions-sdk
+Version: 1.1.1
+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
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.7
+Requires-Python: >=3.10
 Provides-Extra: cli
 Requires-Dist: dt-cli==1.6.13; extra == 'cli'
 Requires-Dist: pyyaml; extra == 'cli'
@@ -32,19 +32,55 @@ Description-Content-Type: text/markdown
 
 **Table of Contents**
 
-- [Installation](#installation)
+- [Quick Start](#quick-start)
 - [License](#license)
 - [Developing](#developing)
 
-## Installation
+## Quick Start
 
-```console
-pip install dt-extensions-sdk
+### 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\]
 ```
 
-## License
+### Create signing certificates
+
+```bash
+dt-sdk gencerts
+```
 
-`dt-extensions-sdk` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+### 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
 
@@ -64,4 +100,14 @@ hatch run lint:all
 
 ```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.

dt_extensions_sdk-1.1.1/README.md

@@ -0,0 +1,88 @@
+# 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/pypi/pyversions/dt-extensions-sdk.svg)](https://pypi.org/project/dt-extensions-sdk)
+
+-----
+
+**Table of Contents**
+
+- [Quick Start](#quick-start)
+- [License](#license)
+- [Developing](#developing)
+
+## 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.

dt_extensions_sdk-1.1.1/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.1.1/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.1.1/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.1.1/docs/api/extension.rst

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

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

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

dt_extensions_sdk-1.1.1/docs/api/metrics/metric.rst

@@ -0,0 +1,19 @@
+Metric
+======
+
+The :class:`dynatrace_extension.Metric` class is mostly used internally to
+construct metrics that comply with the MINT protocol which is what Extension
+Framework uses to send event to the environment.
+
+When the :meth:`dynatrace_extension.Extension.report_metric` method is
+called, it builds a :class:`Metric` object, which is. then added to the list
+of metrics to be sent to the environment. The class has a useful method called
+:meth:`dynatrace_extension.Metric.to_mint_line` which allows you to convert
+the metric to a string that complies with the MINT protocol.
+
+Members
+^^^^^^^
+
+.. autoclass:: dynatrace_extension.Metric
+   :members:
+   :undoc-members:

dt_extensions_sdk-1.1.1/docs/api/metrics/metric_type.rst

@@ -0,0 +1,18 @@
+Metric Type
+===========
+
+There are two types of metrics that can be sent to Dynatrace:
+
+* **Gauge** - A gauge is a metric that represents a single numerical value
+  that can arbitrarily go up and down. For example, current percentage of
+  the CPU usage.
+* **Counters** - A counter is a metric that is continuously increasing.
+  For example, the number of bytes received over a network interface since
+  the start of the process.
+
+Members
+^^^^^^^
+
+.. autoclass:: dynatrace_extension.MetricType
+    :members:
+    :undoc-members:

dt_extensions_sdk-1.1.1/docs/cli/assemble.rst

@@ -0,0 +1,4 @@
+Assemble
+========
+
+.. command-output:: dt-sdk assemble --help

dt_extensions_sdk-1.1.1/docs/cli/build.rst

@@ -0,0 +1,4 @@
+Build
+=====
+
+.. command-output:: dt-sdk build --help

dt_extensions_sdk-1.1.1/docs/cli/create.rst

@@ -0,0 +1,4 @@
+Create
+======
+
+.. command-output:: dt-sdk create --help

dt_extensions_sdk-1.1.1/docs/cli/gencerts.rst

@@ -0,0 +1,4 @@
+Generate Certificates
+=====================
+
+.. command-output:: dt-sdk gencerts --help

dt_extensions_sdk-1.1.1/docs/cli/help.rst

@@ -0,0 +1,4 @@
+Help
+====
+
+.. command-output:: dt-sdk --help

dt_extensions_sdk-1.1.1/docs/cli/run.rst

@@ -0,0 +1,4 @@
+Run
+===
+
+.. command-output:: dt-sdk run --help

dt_extensions_sdk-1.1.1/docs/cli/sign.rst

@@ -0,0 +1,4 @@
+Sign
+====
+
+.. command-output:: dt-sdk sign --help

dt_extensions_sdk-1.1.1/docs/cli/upload.rst

@@ -0,0 +1,4 @@
+Upload
+======
+
+.. command-output:: dt-sdk upload --help

dt_extensions_sdk-1.1.1/docs/cli/wheel.rst

@@ -0,0 +1,4 @@
+Wheel
+=====
+
+.. command-output:: dt-sdk wheel --help

dt_extensions_sdk-1.1.1/docs/conf.py

@@ -0,0 +1,98 @@
+# 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
+from datetime import datetime
+
+sys.path.insert(0, os.path.abspath("."))
+
+
+# -- Project information -----------------------------------------------------
+project = "dt-sdk"
+copyright = f"2023–{datetime.now().year}, Dynatrace LLC"
+author = "Dynatrace"
+
+# Short version
+version = "1.0.0"
+# The full version, including alpha/beta/rc tags
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+
+# -- 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",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosectionlabel",
+    "sphinx_wagtail_theme",
+    "sphinxcontrib.programoutput",
+]
+
+# 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"]
+
+# True to prefix each section label with the name of the document it is in,
+# followed by a colon. For example, index:Introduction for a section called
+# Introduction that appears in document index.rst. Useful for avoiding
+# ambiguity when the same section heading appears in different documents.
+autosectionlabel_prefix_document = True
+
+# -- Autodoc -----------------------------------------------------------------
+
+autodoc_default_options = {"member-order": "bysource", "undoc-members": True}
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_wagtail_theme"
+html_favicon = "_static/favicon.ico"
+html_show_copyright = True
+
+# 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_sidebars = {"**": ["search-field.html", "sidebar-nav-bs.html"]}
+
+html_theme_options = {
+    "project_name": "dt-sdk",
+    "logo": "dt-sdk-logo.png",
+    "logo_alt": "dt-sdk",
+    "logo_url": "/",
+    "github_url": "https://github.com/dynatrace-extensions/dt-extensions-python-sdk",
+    "footer_links": ",".join(
+        [
+            "Dynatrace|https://dynatrace.com/",
+            "Extensions Team|mailto:extenions@dynatrace.com",
+        ]
+    ),
+}