diff --git a/Rakefile b/Rakefile index 8a014388abe..c867f1de38f 100644 --- a/Rakefile +++ b/Rakefile @@ -1,17 +1,21 @@ -# Dev commands + +desc "run tests" task :test do sh "python setup.py test" end +desc "install the library in dev mode" task :dev do sh "pip uninstall -y ddtrace" sh "pip install -e ." end +desc "remove artifacts" task :clean do sh 'rm -rf build *egg*' end +desc "build the docs" task :docs do Dir.chdir 'docs' do sh "make html" diff --git a/circle.yml b/circle.yml index 45b4c38b93a..3186b778d38 100644 --- a/circle.yml +++ b/circle.yml @@ -10,7 +10,11 @@ dependencies: - sudo service postgresql stop - sudo service redis-server stop # install of mock fails otherwise + - pip2.7 install -U setuptools - pip3.4 install -U setuptools + # Pre-install all dependencies + - python2.7 setup.py test -n + - python3.4 setup.py test -n test: override: - docker run -d -p 9200:9200 elasticsearch:2.3 @@ -25,12 +29,12 @@ deployment: # CircleCI is configured to provide VERSION_SUFFIX=$CIRCLE_BRANCH$CIRCLE_BUILD_NUM commands: - pip install mkwheelhouse sphinx - - S3_DIR=apm_dev rake release_wheel - - S3_DIR=apm_dev rake release_docs + - S3_DIR=trace-dev rake release_wheel + - S3_DIR=trace-dev rake release_docs unstable: tag: /v[0-9]+(\.[0-9]+)*/ # Nullify VERSION_SUFFIX to deploy the package with its public version commands: - pip install mkwheelhouse sphinx - - S3_DIR=apm_unstable VERSION_SUFFIX= rake release_wheel - - S3_DIR=apm_unstable rake release_docs + - S3_DIR=trace VERSION_SUFFIX= rake release_wheel + - S3_DIR=trace rake release_docs diff --git a/ddtrace/contrib/flask/__init__.py b/ddtrace/contrib/flask/__init__.py index 0ea573d4891..74512af2df5 100644 --- a/ddtrace/contrib/flask/__init__.py +++ b/ddtrace/contrib/flask/__init__.py @@ -6,7 +6,10 @@ To install the middleware, do the following:: from flask import Flask + import blinker as _ + from ddtrace import tracer + from ddtrace.contrib.flask import TraceMiddleware app = Flask(...) diff --git a/docs/index.rst b/docs/index.rst index b603205aff4..f2124298e24 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,6 +14,10 @@ have great visiblity into bottlenecks and troublesome requests. Installation ------------ +Install with :code:`pip` but point to Datadog's package repo:: + + $ pip install ddtrace --find-links=https://s3.amazonaws.com/pypi.datadoghq.com/trace/index.html + Quick Start -----------