From 691a4b860da0120e41e72ff2dfd44dd663d76760 Mon Sep 17 00:00:00 2001 From: Reiley Yang Date: Tue, 24 Sep 2019 20:46:01 -0700 Subject: [PATCH 1/2] move example app to the examples folder --- .../opentelemetry-example-app}/README.rst | 0 .../opentelemetry-example-app}/setup.py | 0 .../src/opentelemetry_example_app/__init__.py | 0 .../opentelemetry_example_app/flask_example.py | 0 .../opentelemetry-example-app}/tests/__init__.py | 0 .../tests/test_flask_example.py | 0 tox.ini | 16 ++++++++-------- 7 files changed, 8 insertions(+), 8 deletions(-) rename {opentelemetry-example-app => examples/opentelemetry-example-app}/README.rst (100%) rename {opentelemetry-example-app => examples/opentelemetry-example-app}/setup.py (100%) rename {opentelemetry-example-app => examples/opentelemetry-example-app}/src/opentelemetry_example_app/__init__.py (100%) rename {opentelemetry-example-app => examples/opentelemetry-example-app}/src/opentelemetry_example_app/flask_example.py (100%) rename {opentelemetry-example-app => examples/opentelemetry-example-app}/tests/__init__.py (100%) rename {opentelemetry-example-app => examples/opentelemetry-example-app}/tests/test_flask_example.py (100%) diff --git a/opentelemetry-example-app/README.rst b/examples/opentelemetry-example-app/README.rst similarity index 100% rename from opentelemetry-example-app/README.rst rename to examples/opentelemetry-example-app/README.rst diff --git a/opentelemetry-example-app/setup.py b/examples/opentelemetry-example-app/setup.py similarity index 100% rename from opentelemetry-example-app/setup.py rename to examples/opentelemetry-example-app/setup.py diff --git a/opentelemetry-example-app/src/opentelemetry_example_app/__init__.py b/examples/opentelemetry-example-app/src/opentelemetry_example_app/__init__.py similarity index 100% rename from opentelemetry-example-app/src/opentelemetry_example_app/__init__.py rename to examples/opentelemetry-example-app/src/opentelemetry_example_app/__init__.py diff --git a/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py b/examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py similarity index 100% rename from opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py rename to examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py diff --git a/opentelemetry-example-app/tests/__init__.py b/examples/opentelemetry-example-app/tests/__init__.py similarity index 100% rename from opentelemetry-example-app/tests/__init__.py rename to examples/opentelemetry-example-app/tests/__init__.py diff --git a/opentelemetry-example-app/tests/test_flask_example.py b/examples/opentelemetry-example-app/tests/test_flask_example.py similarity index 100% rename from opentelemetry-example-app/tests/test_flask_example.py rename to examples/opentelemetry-example-app/tests/test_flask_example.py diff --git a/tox.ini b/tox.ini index 871931dc55a..f8d2f55d284 100644 --- a/tox.ini +++ b/tox.ini @@ -22,9 +22,9 @@ setenv = changedir = test-api: opentelemetry-api/tests test-sdk: opentelemetry-sdk/tests - test-example-app: opentelemetry-example-app/tests - test-ext-wsgi: ext/opentelemetry-ext-wsgi/tests test-ext-http-requests: ext/opentelemetry-ext-http-requests/tests + test-ext-wsgi: ext/opentelemetry-ext-wsgi/tests + test-example-app: examples/opentelemetry-example-app/tests commands_pre = ; Install without -e to test the actual installation @@ -32,9 +32,9 @@ commands_pre = test: pip install {toxinidir}/opentelemetry-api test-sdk: pip install {toxinidir}/opentelemetry-sdk example-app: pip install {toxinidir}/opentelemetry-sdk - example-app: pip install {toxinidir}/ext/opentelemetry-ext-wsgi example-app: pip install {toxinidir}/ext/opentelemetry-ext-http-requests - example-app: pip install {toxinidir}/opentelemetry-example-app + example-app: pip install {toxinidir}/ext/opentelemetry-ext-wsgi + example-app: pip install {toxinidir}/examples/opentelemetry-example-app ext: pip install {toxinidir}/opentelemetry-api wsgi: pip install {toxinidir}/ext/opentelemetry-ext-wsgi http-requests: pip install {toxinidir}/ext/opentelemetry-ext-http-requests @@ -67,9 +67,9 @@ commands_pre = pip install -e {toxinidir}/opentelemetry-api pip install -e {toxinidir}/opentelemetry-sdk pip install -e {toxinidir}/ext/opentelemetry-ext-azure-monitor - pip install -e {toxinidir}/ext/opentelemetry-ext-wsgi pip install -e {toxinidir}/ext/opentelemetry-ext-http-requests - pip install -e {toxinidir}/opentelemetry-example-app + pip install -e {toxinidir}/ext/opentelemetry-ext-wsgi + pip install -e {toxinidir}/examples/opentelemetry-example-app commands = ; Prefer putting everything in one pylint command to profit from duplication @@ -85,8 +85,8 @@ commands = ext/opentelemetry-ext-http-requests/src/ \ ext/opentelemetry-ext-http-requests/tests/ \ ext/opentelemetry-ext-wsgi/tests/ \ - opentelemetry-example-app/src/opentelemetry_example_app/ \ - opentelemetry-example-app/tests/ + examples/opentelemetry-example-app/src/opentelemetry_example_app/ \ + examples/opentelemetry-example-app/tests/ flake8 . isort --check-only --diff --recursive . From 19e817bee1c013b374687000b8c481e1e153365c Mon Sep 17 00:00:00 2001 From: Reiley Yang Date: Wed, 25 Sep 2019 08:20:11 -0700 Subject: [PATCH 2/2] update the example link in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 097f3e146c8..4b4e0f25ab3 100644 --- a/README.md +++ b/README.md @@ -60,8 +60,8 @@ with tracer.start_span('foo'): See the [API documentation](https://open-telemetry.github.io/opentelemetry-python/) for more detail, and the -[opentelemetry-example-app](./opentelemetry-example-app/README.rst) for a -complete example. +[opentelemetry-example-app](./examples/opentelemetry-example-app/README.rst) +for a complete example. ## Contributing