Commit initial version (manual sync).

Author: Oberon00

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.gitignore

@@ -0,0 +1,12 @@
+*.pyc
+*.pyo
+build/
+__pycache__/
+onesdk_shared.dll
+.tox/
+dist/
+/MANIFEST
+.cache/
+/tmp/
+*.egg-info
+.pytest_cache/

MANIFEST.in

@@ -0,0 +1,5 @@
+prune test
+graft src
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude __pycache__/*

README.md

@@ -0,0 +1,47 @@
+**Disclaimer: This SDK is currently in early access and still work in
+progress.**
+
+
+# Dynatrace OneAgent SDK for Python
+
+This SDK enables Dynatrace customers to extend request level visibility into
+Python applications.
+
+It provides the Python implementation of the [Dynatrace OneAgent
+SDK](https://github.com/Dynatrace/OneAgent-SDK). 
+
+
+## Package contents
+
+- `LICENSE`: License under which the whole SDK and sample applications are
+  published.
+- `src/`: Actual source code of the Python OneAgent SDK.
+- `docs/`: Source files for the ([Sphinx](https://sphinx-doc.org)-based) HTML
+  documentation. For the actual, readable documentation, see
+  [here](#documenation).
+- `tests/`: Contains tests that are useful (only) for developers wanting
+  contribute to the SDK itself.
+- `setup.py`, `setup.cfg`, `MANIFEST.in`: Development Files required for
+  creating e.g. the PyPI package for the Python OneAgent SDK.
+- `tox.ini`, `pylintrc`: Supporting files for developing the SDK itself. See
+  <https://tox.readthedocs.io/en/latest/> and <https://www.pylint.org/>.
+
+
+## Features
+
+Dynatrace OneAgent SDK for Python currently implements support for the following
+features (corresponding to features specified in [Dynatrace OneAgent
+SDK](https://github.com/Dynatrace/OneAgent-SDK)):
+
+- Outgoing and incoming remote calls
+- SQL Database requests
+- Incoming web requests
+
+
+## Documentation
+
+The reference documentation is included in this package. The most recent version
+is also available online at <https://dynatrace.github.io/OneAgent-SDK-for-Python/>
+
+A high level documentation/description of OneAgent SDK concepts is available at
+<https://github.com/Dynatrace/OneAgent-SDK/>.

docs/conf.py

@@ -0,0 +1,199 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# OneAgent and SDK for Python documentation build configuration file, created by
+# sphinx-quickstart on Mon Dec  4 14:43:27 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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
+# sys.path.insert(0, os.path.abspath('.'))
+
+# Fix spurious "= None" for instance attributes
+# https://github.com/sphinx-doc/sphinx/issues/2044
+from sphinx.ext.autodoc import (
+    ClassLevelDocumenter, InstanceAttributeDocumenter)
+
+def iad_add_directive_header(self, sig):
+    ClassLevelDocumenter.add_directive_header(self, sig)
+
+InstanceAttributeDocumenter.add_directive_header = iad_add_directive_header
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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.intersphinx',
+    'sphinx.ext.coverage',
+    'sphinx.ext.githubpages']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Dynatrace OneAgent and SDK for Python'
+copyright = '2017, Dynatrace LLC'
+author = 'Dynatrace LLC'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# 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 = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- 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 = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'searchbox.html',
+        'localtoc.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OneAgentandSDKforPythondoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'OneAgentandSDKforPython.tex', 'OneAgent and SDK for Python Documentation',
+     'Dynatrace LLC', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'oneagentandsdkforpython', 'OneAgent and SDK for Python Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'OneAgentandSDKforPython', 'OneAgent and SDK for Python Documentation',
+     author, 'OneAgentandSDKforPython', 'Dynatrace OneAgent and SDK for Python',
+     'Miscellaneous'),
+]
+
+# -- Other ----------------------------------------------------------------
+
+intersphinx_mapping = {'python': ('https://docs.python.org/3/', None)}
+
+# http://www.sphinx-doc.org/en/master/config.html#confval-nitpicky
+# Sphinx will warn about all references where the target cannot be found.
+nitpicky = True
+nitpick_ignore = [
+    ('envvar', 'DT_HOME'),
+    ('py:class', 'callable'),
+    ('py:class', 'unicode'),
+    ('py:class', 'typing.Union'),
+    ('py:class', 'typing.Tuple'),
+    ('py:class', 'oneagent.common._Uninstantiable')
+]
+
+autodoc_member_order = 'bysource'

docs/encoding.rst

@@ -0,0 +1,28 @@
+.. _encoding:
+
+String encoding and unicode issues
+==================================
+
+This section mostly concerns Python 2.
+
+When the documentation says that a :class:`str` is accepted, an :class:`unicode`
+is also always accepted on Python 2. What is more, when the documentation says
+that a :class:`str` is returned or passed to a callback, on Python 2 it is
+actually a :class:`unicode` (you mostly don't need to care about that though,
+because most string operations on Python 2 allow mixing :class:`str` and
+:class:`unicode`).
+
+When passing a :class:`bytes` object (or, equivalently, a :code:`str` object on
+Python 2) to a SDK function that says that it accepts a :class:`str`, the bytes
+will be interpreted as being UTF-8 encoded. Beware: If the string has invalid
+UTF-8 (e.g. Latin-1/ISO-8859-1, as it may occur in :ref:`HTTP headers
+<http-encoding-warning>`), the function to which it was passed may fail either
+partially or fully. Such failures are guaranteed to neither throw exceptions nor
+violate any invariants of the involved objects, but some or all of the
+information passed in that function call may be lost (E.g. a single invalid HTTP
+header passed to :meth:`oneagent.sdk.SDK.trace_incoming_web_request` may cause
+an null-tracer to be returned -- but it is also allowed to e.g. truncate that
+HTTP header and discard all that follow; the exact failure mode is undefined and
+you should take care to not pass invalid strings). Also, the diagnostic callback
+(:meth:`oneagent.sdk.SDK.set_diagnostic_callback`) may be invoked (but is not
+guaranteed to).

docs/index.rst

@@ -0,0 +1,20 @@
+Welcome to the documentation for Dynatrace OneAgent and SDK for Python
+======================================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   quickstart
+   sdkref
+   encoding
+   tagging
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/quickstart.rst

@@ -0,0 +1,8 @@
+Quickstart
+==========
+
+The following example shows most features of the Python SDK:
+
+.. literalinclude:: ../test/onesdksamplepy.py
+
+See the rest of the documentation for more information.

docs/sdkref.rst

@@ -0,0 +1,37 @@
+Public SDK API Reference
+========================
+
+For a high-level overview of SDK concepts, see
+https://github.com/Dynatrace/OneAgent-SDK.
+
+Module :code:`oneagent` (initialization)
+----------------------------------------
+
+.. automodule:: oneagent
+  :members: sdkopts_from_commandline, try_init, shutdown
+
+..
+  .. autofunction:: oneagent.start_agent
+  .. autofunction:: oneagent.try_start_agent
+
+Module :code:`oneagent.sdk`
+---------------------------
+
+.. automodule:: oneagent.sdk
+   :members: SDK
+   :show-inheritance:
+
+Module :code:`oneagent.sdk.tracers`
+-----------------------------------
+
+.. automodule:: oneagent.sdk.tracers
+   :members:
+   :show-inheritance:
+
+Module :code:`oneagent.common`
+----------------------------------
+
+.. automodule:: oneagent.common
+   :members:
+   :show-inheritance:
+