Add eachdist.py to simplify build (open-telemetry#291)

Oberon00 · c24t · commit b25af7fe39b0 · 2019-12-09T17:54:56.000-08:00
diff --git a/.flake8 b/.flake8
@@ -11,6 +11,8 @@ exclude =
   .svn
   .tox
   CVS
+  .venv*/
+  venv*/
   target
   __pycache__
   ext/opentelemetry-ext-jaeger/src/opentelemetry/ext/jaeger/gen/
diff --git a/.gitignore b/.gitignore
@@ -20,6 +20,7 @@ lib
 lib64
 __pycache__
 venv*/
+.venv*/
 
 # Installer logs
 pip-log.txt
diff --git a/.isort.cfg b/.isort.cfg
@@ -13,5 +13,5 @@ line_length=79
 ; docs: https://github.com/timothycrosley/isort#multi-line-output-modes
 multi_line_output=3
 skip=target
-skip_glob=ext/opentelemetry-ext-jaeger/src/opentelemetry/ext/jaeger/gen/*
+skip_glob=ext/opentelemetry-ext-jaeger/src/opentelemetry/ext/jaeger/gen/*,.venv*/*,venv*/*
 known_first_party=opentelemetry
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -28,7 +28,14 @@ during their normal contribution hours.
 
 ## Development
 
-This project uses [`tox`](https://tox.readthedocs.io) to automate some aspects
+To quickly get up and running, you can use the `scripts/eachdist.py` tool that
+ships with this project. First create a virtualenv and activate it.
+Then run `python scripts/eachdist.py develop` to install all required packages
+as well as the project's packages themselves (in `--editable` mode).
+You can then run `scripts/eachdist.py test` to test everything or
+`scripts/eachdist.py lint` to lint everything (fixing anything that is auto-fixable).
+
+Additionally, this project uses [`tox`](https://tox.readthedocs.io) to automate some aspects
 of development, including testing against multiple Python versions.
 
 You can run:
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -0,0 +1,10 @@
+pylint~=2.3
+flake8~=3.7
+isort~=4.3
+black>=19.3b0,==19.*
+mypy==0.740
+sphinx~=2.1
+sphinx-rtd-theme~=0.4
+sphinx-autodoc-typehints~=1.10.2
+pytest!=5.2.3
+pytest-cov>=2.8
diff --git a/eachdist.ini b/eachdist.ini
@@ -0,0 +1,16 @@
+# These will be sorted first in that order.
+# All packages that are depended upon by others should be listed here.
+[DEFAULT]
+sortfirst=
+    opentelemetry-api
+    opentelemetry-sdk
+    ext/opentelemetry-ext-wsgi
+    ext/*
+
+[lintroots]
+extraroots=examples/*,scripts/
+subglob=*.py,tests/,test/,src/*,examples/*
+
+[testroots]
+extraroots=examples/*,tests/
+subglob=tests/,test/
diff --git a/ext/opentelemetry-ext-testutil/setup.cfg b/ext/opentelemetry-ext-testutil/setup.cfg
@@ -38,7 +38,7 @@ package_dir=
     =src
 packages=find_namespace:
 install_requires =
-    opentelemetry-ext-wsgi
+    opentelemetry-api
 
 [options.extras_require]
 test = flask~=1.0
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,21 +3,7 @@ line-length = 79
 exclude = '''
 (
   /(
-      \.eggs         # exclude a few common directories in the
-    | \.git          # root of the project
-    | \.hg
-    | \.mypy_cache
-    | \.tox
-    | \.venv
-    | \.vscode
-    | _build
-    | buck-out
-    | target
-    | build
-    | dist
-    | ext/opentelemetry-ext-jaeger/src/opentelemetry/ext/jaeger/gen     # generated files
+    ext/opentelemetry-ext-jaeger/src/opentelemetry/ext/jaeger/gen     # generated files
   )/
-  | foo.py           # also separately exclude a file named foo.py in
-                     # the root of the project
 )
 '''
diff --git a/scripts/eachdist.py b/scripts/eachdist.py
diff --git a/tox.ini b/tox.ini
