hectorhdzg
diff --git a/‎.flake8
+1 b/‎.flake8
+1
diff --git a/‎.github/workflows/docs.yml
+23 b/‎.github/workflows/docs.yml
+23
diff --git a/‎.isort.cfg
+1 b/‎.isort.cfg
+1
diff --git a/‎.pylintrc
+1-1 b/‎.pylintrc
+1-1
diff --git a/‎CONTRIBUTING.md
+10-26 b/‎CONTRIBUTING.md
+10-26
diff --git a/‎README.md
+70-29 b/‎README.md
+70-29
diff --git a/‎dev-requirements.txt
-1 b/‎dev-requirements.txt
-1
diff --git a/‎docs/conf.py
+3 b/‎docs/conf.py
+3
diff --git a/‎docs/opentelemetry.metrics.rst
-7 b/‎docs/opentelemetry.metrics.rst
-7
diff --git a/‎docs/opentelemetry.metrics.time_series.rst
-5 b/‎docs/opentelemetry.metrics.time_series.rst
-5
diff --git a/‎docs/opentelemetry.trace.rst
+11-1 b/‎docs/opentelemetry.trace.rst
+11-1
diff --git a/‎docs/opentelemetry.trace.status.rst
+7 b/‎docs/opentelemetry.trace.status.rst
+7
diff --git a/‎opentelemetry-example-app/README.rst renamed to ‎examples/opentelemetry-example-app/README.rst b/‎opentelemetry-example-app/README.rst renamed to ‎examples/opentelemetry-example-app/README.rst
diff --git a/‎opentelemetry-example-app/setup.py renamed to ‎examples/opentelemetry-example-app/setup.py b/‎opentelemetry-example-app/setup.py renamed to ‎examples/opentelemetry-example-app/setup.py
diff --git a/‎opentelemetry-example-app/src/opentelemetry_example_app/__init__.py renamed to ‎examples/opentelemetry-example-app/src/opentelemetry_example_app/__init__.py b/‎opentelemetry-example-app/src/opentelemetry_example_app/__init__.py renamed to ‎examples/opentelemetry-example-app/src/opentelemetry_example_app/__init__.py
diff --git a/‎opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py renamed to ‎examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py
+12-6 b/‎opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py renamed to ‎examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py
+12-6
diff --git a/‎examples/opentelemetry-example-app/src/opentelemetry_example_app/metrics_example.py
+39 b/‎examples/opentelemetry-example-app/src/opentelemetry_example_app/metrics_example.py
+39
diff --git a/‎opentelemetry-example-app/tests/__init__.py renamed to ‎examples/opentelemetry-example-app/tests/__init__.py b/‎opentelemetry-example-app/tests/__init__.py renamed to ‎examples/opentelemetry-example-app/tests/__init__.py
@@ -1,2 +1,3 @@
 [flake8]
 ignore = E501,W503,E203
+exclude = .svn,CVS,.bzr,.hg,.git,__pycache__,.tox,ext/opentelemetry-ext-jaeger/src/opentelemetry/ext/jaeger/gen/,ext/opentelemetry-ext-jaeger/build/*
@@ -0,0 +1,23 @@
+name: Docs
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-python@v1
+    - name: Build docs
+      run: |
+        pip install --upgrade tox
+        tox -e docs
+    - name: Publish to gh-pages
+      uses: JamesIves/[email protected]
+      env:
+        ACCESS_TOKEN: ${{ secrets.DocsPushToken }}
+        BRANCH: gh-pages
+        FOLDER: docs/_build/html/
@@ -12,3 +12,4 @@ line_length=79
 ; )
 ; docs: https://github.com/timothycrosley/isort#multi-line-output-modes
 multi_line_output=3
+skip_glob=ext/opentelemetry-ext-jaeger/src/opentelemetry/ext/jaeger/gen/*
@@ -7,7 +7,7 @@ extension-pkg-whitelist=
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.
-ignore=CVS
+ignore=CVS,gen
 
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
 
@@ -8,6 +8,11 @@ See the [public meeting notes](https://docs.google.com/document/d/1CIMGoIOZ-c3-i
 for a summary description of past meetings. To request edit access, join the
 meeting or get in touch on [Gitter](https://gitter.im/open-telemetry/opentelemetry-python).
 
+See to the [community membership document](https://github.com/open-telemetry/community/blob/master/community-membership.md)
+on how to become a [**Member**](https://github.com/open-telemetry/community/blob/master/community-membership.md#member),
+[**Approver**](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver)
+and [**Maintainer**](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer).
+
 ## Development
 
 This project uses [`tox`](https://tox.readthedocs.io) to automate some aspects
@@ -37,7 +42,7 @@ pull requests (PRs).
 To create a new PR, fork the project in GitHub and clone the upstream repo:
 
 ```sh
-$ git clone https://https://github.com/open-telemetry/opentelemetry-python.git
+$ git clone https://github.com/open-telemetry/opentelemetry-python.git
 ```
 
 Add your fork as an origin:
@@ -74,15 +79,16 @@ Open a pull request against the main `opentelemetry-python` repo.
 ### How to Get PRs Merged
 
 A PR is considered to be **ready to merge** when:
-* It has received two approvals from Collaborators/Maintainers (at different
-  companies).
+* It has received two approvals from [Approvers](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver)
+  / [Maintainers](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer)
+  (at different companies).
 * Major feedbacks are resolved.
 * It has been open for review for at least one working day. This gives people
   reasonable time to review.
 * Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day.
 * Urgent fix can take exception as long as it has been actively communicated.
 
-Any Collaborator/Maintainer can merge the PR once it is **ready to merge**.
+Any Approver / Maintainer can merge the PR once it is **ready to merge**.
 
 ## Design Choices
 
@@ -111,25 +117,3 @@ For a deeper discussion, see: https://github.com/open-telemetry/opentelemetry-sp
   as specified with the [napolean
   extension](http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#google-vs-numpy)
   extension in [Sphinx](http://www.sphinx-doc.org/en/master/index.html).
-
-## Become a Collaborator
-
-Collaborators have write access to the repo.
-
-To become a Collaborator:
-* Become an active Contributor by working on PRs.
-* Actively participate in the community meeting, design discussion, PR review
-   and issue discussion.
-* Contact the Maintainers, express the willingness and commitment.
-* Acknowledged and approved by two Maintainers (at different companies).
-
-## Become a Maintainer
-
-Maintainers have admin access to the repo.
-
-To become a Maintainer:
-* Become a [member of OpenTelemetry organization](https://github.com/orgs/open-telemetry/people).
-* Become a Collaborator.
-* Demonstrate the ability and commitment.
-* Contact the Maintainers, express the willingness and commitment.
-* Acknowledged and approved by all the current Maintainers.
@@ -16,16 +16,16 @@ The `opentelemetry-sdk` package is the reference implementation of the API.
 
 Libraries that produce telemetry data should only depend on `opentelemetry-api`,
 and defer the choice of the SDK to the application developer. Applications may
-depend on `opentelemetry-sdk` or another package that implements the API. 
+depend on `opentelemetry-sdk` or another package that implements the API.
 
-To install the API and SDK packages, fork or clone this repo and do an
-[editable
-install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)
-via `pip`:
+**Please note** that this library is currently in _alpha_, and shouldn't be
+used in production environments.
+
+The API and SDK packages are available on PyPI, and can installed via `pip`:
 
 ```sh
-pip install -e ./opentelemetry-api
-pip install -e ./opentelemetry-sdk
+pip install opentelemetry-api
+pip install opentelemetry-sdk
 ```
 
 The
@@ -34,6 +34,16 @@ directory includes OpenTelemetry integration packages, which can be installed
 separately as:
 
 ```sh
+pip install opentelemetry-ext-{integration}
+```
+
+To install the development versions of these packages instead, clone or fork
+this repo and do an [editable
+install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs):
+
+```sh
+pip install -e ./opentelemetry-api
+pip install -e ./opentelemetry-sdk
 pip install -e ./ext/opentelemetry-ext-{integration}
 ```
 
@@ -43,41 +53,72 @@ pip install -e ./ext/opentelemetry-ext-{integration}
 from opentelemetry import trace
 from opentelemetry.context import Context
 from opentelemetry.sdk.trace import Tracer
+from opentelemetry.sdk.trace.export import ConsoleSpanExporter
+from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor
 
 trace.set_preferred_tracer_implementation(lambda T: Tracer())
 tracer = trace.tracer()
+tracer.add_span_processor(
+    SimpleExportSpanProcessor(ConsoleSpanExporter())
+)
 with tracer.start_span('foo'):
-    print(Context)
     with tracer.start_span('bar'):
-        print(Context)
         with tracer.start_span('baz'):
             print(Context)
-        print(Context)
-    print(Context)
 ```
 
-See [opentelemetry-example-app](./opentelemetry-example-app/README.rst) for a complete example.
+See the [API
+documentation](https://open-telemetry.github.io/opentelemetry-python/) for more
+detail, and the
+[opentelemetry-example-app](./examples/opentelemetry-example-app/README.rst)
+for a complete example.
 
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md)
 
 ## Release Schedule
 
-OpenTelemetry Python is under active development. Our goal is to release an
-_alpha_ version of the library at the end of September 2019. This release isn't
-guaranteed to conform to a specific version of the specification, and future
-releases will not attempt to maintain backwards compatibility with the alpha
-release.
-
-| Component                   | Version | Target Date       |
-| --------------------------- | ------- | ----------------- |
-| Tracing API                 | Alpha   | September 30 2019 |
-| Tracing SDK                 | Alpha   | September 30 2019 |
-| Metrics API                 | Alpha   | September 30 2019 |
-| Metrics SDK                 | Alpha   | September 30 2019 |
-| Jaeger Trace Exporter       | Alpha   | Unknown           |
-| Prometheus Metrics Exporter | Alpha   | Unknown           |
-| Context Propagation         | Alpha   | September 30 2019 |
-| OpenTracing Bridge          | Alpha   | Unknown           |
-| OpenCensus Bridge           | Alpha   | Unknown           |
+OpenTelemetry Python is under active development.
+
+The library is not yet _generally available_, and releases aren't guaranteed to
+conform to a specific version of the specification. Future releases will not
+attempt to maintain backwards compatibility with previous releases.
+
+The [v0.1 alpha
+release](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.1.0)
+includes:
+
+- Tracing API
+- Tracing SDK
+- Metrics API
+- Metrics SDK (Partial)
+- W3C Trace Context Propagation
+- B3 Context Propagation
+- HTTP Integrations
+
+See the [project
+milestones](https://github.com/open-telemetry/opentelemetry-python/milestones)
+for details on upcoming releases. The dates and features described here are
+estimates, and subject to change.
+
+Future releases targets include:
+
+| Component                   | Version    | Target Date     |
+| --------------------------- | ---------- | --------------- |
+| Jaeger Trace Exporter       | Alpha v0.2 | October 28 2019 |
+| Metrics SDK (Complete)      | Alpha v0.2 | October 28 2019 |
+| Prometheus Metrics Exporter | Alpha v0.2 | October 28 2019 |
+| OpenTracing Bridge          | Alpha v0.2 | October 28 2019 |
+
+| Component                           | Version    | Target Date      |
+| ----------------------------------- | ---------- | ---------------- |
+| Zipkin Trace Exporter               | Alpha v0.3 | November 15 2019 |
+| W3C Correlation Context Propagation | Alpha v0.3 | November 15 2019 |
+| Support for Tags/Baggage            | Alpha v0.3 | November 15 2019 |
+| Metrics Aggregation                 | Alpha v0.3 | November 15 2019 |
+| gRPC Integrations                   | Alpha v0.3 | November 15 2019 |
+
+| Component         | Version    | Target Date      |
+| ----------------- | ---------- | ---------------- |
+| OpenCensus Bridge | Alpha v0.4 | December 31 2019 |
@@ -42,6 +42,9 @@
     "sphinx.ext.viewcode",
     # Link to other sphinx docs
     "sphinx.ext.intersphinx",
+    # Add a .nojekyll file to the generated HTML docs
+    # https://help.github.com/en/articles/files-that-start-with-an-underscore-are-missing
+    "sphinx.ext.githubpages",
 ]
 
 intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
 
@@ -1,13 +1,6 @@
 opentelemetry.metrics package
 =============================
 
-Submodules
-----------
-
-.. toctree::
-
-   opentelemetry.metrics.time_series
-
 Module contents
 ---------------
 
 
@@ -1,4 +1,14 @@
 opentelemetry.trace package
 ===========================
 
-.. automodule:: opentelemetry.trace
+Submodules
+----------
+
+.. toctree::
+
+   opentelemetry.trace.status
+
+Module contents
+---------------
+
+.. automodule:: opentelemetry.trace
@@ -0,0 +1,7 @@
+opentelemetry.trace.status
+==========================
+
+.. automodule:: opentelemetry.trace.status
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -16,13 +16,13 @@
 This module serves as an example to integrate with flask, using
 the requests library to perform downstream requests
 """
-import time
-
 import flask
+import requests
 
 import opentelemetry.ext.http_requests
-from opentelemetry import trace
+from opentelemetry import propagators, trace
 from opentelemetry.ext.wsgi import OpenTelemetryMiddleware
+from opentelemetry.sdk.context.propagation.b3_format import B3Format
 from opentelemetry.sdk.trace import Tracer
 
 
@@ -39,14 +39,20 @@ def configure_opentelemetry(flask_app: flask.Flask):
 
     * processors?
     * exporters?
-    * propagators?
     """
     # Start by configuring all objects required to ensure
     # a complete end to end workflow.
     # the preferred implementation of these objects must be set,
     # as the opentelemetry-api defines the interface with a no-op
     # implementation.
     trace.set_preferred_tracer_implementation(lambda _: Tracer())
+    # Next, we need to configure how the values that are used by
+    # traces and metrics are propagated (such as what specific headers
+    # carry this value).
+
+    # TBD: can remove once default TraceContext propagators are installed.
+    propagators.set_global_httptextformat(B3Format())
+
     # Integrations are the glue that binds the OpenTelemetry API
     # and the frameworks and libraries that are used together, automatically
     # creating Spans and propagating context as appropriate.
@@ -61,8 +67,8 @@ def configure_opentelemetry(flask_app: flask.Flask):
 def hello():
     # emit a trace that measures how long the
     # sleep takes
-    with trace.tracer().start_span("sleep"):
-        time.sleep(0.001)
+    with trace.tracer().start_span("example-request"):
+        requests.get("http://www.example.com")
     return "hello"
 
 
 
@@ -0,0 +1,39 @@
+# Copyright 2019, OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""
+This module serves as an example for a simple application using metrics
+"""
+
+from opentelemetry import metrics
+from opentelemetry.sdk.metrics import Counter, Meter
+
+metrics.set_preferred_meter_implementation(lambda _: Meter())
+meter = metrics.meter()
+counter = meter.create_metric(
+    "available memory",
+    "available memory",
+    "bytes",
+    int,
+    Counter,
+    ("environment",),
+)
+
+label_values = ("staging",)
+counter_handle = counter.get_handle(label_values)
+counter_handle.add(100)
+meter.record_batch(label_values, [(counter, 50)])
+print(counter_handle.data)
+
+# TODO: exporters
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`[flake8]`
`2`	`2`	`ignore = E501,W503,E203`
	`3`	`+exclude = .svn,CVS,.bzr,.hg,.git,__pycache__,.tox,ext/opentelemetry-ext-jaeger/src/opentelemetry/ext/jaeger/gen/,ext/opentelemetry-ext-jaeger/build/*`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,9 @@`
`42`	`42`	`"sphinx.ext.viewcode",`
`43`	`43`	`# Link to other sphinx docs`
`44`	`44`	`"sphinx.ext.intersphinx",`
	`45`	`+ # Add a .nojekyll file to the generated HTML docs`
	`46`	`+ # https://help.github.com/en/articles/files-that-start-with-an-underscore-are-missing`
	`47`	`+ "sphinx.ext.githubpages",`
`45`	`48`	`]`
`46`	`49`
`47`	`50`	`intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}`