You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@senssoft.apache.org by ms...@apache.org on 2017/06/22 16:16:22 UTC

[5/6] incubator-senssoft-distill git commit: #SENSSOFT-193: Updated documentation and test runners

#SENSSOFT-193: Updated documentation and test runners


Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/commit/55ae2464
Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/tree/55ae2464
Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/diff/55ae2464

Branch: refs/heads/elk5.4-upgrade
Commit: 55ae2464416739a703522aaf3964dee56b41edde
Parents: cf3a795
Author: msbeard <ms...@apache.org>
Authored: Thu Jun 22 12:13:01 2017 -0400
Committer: msbeard <ms...@apache.org>
Committed: Thu Jun 22 12:13:01 2017 -0400

----------------------------------------------------------------------
 .coveragerc         | 28 ++++++++++++++++++++++++++++
 AUTHORS.rst         |  2 +-
 CHANGELOG.rst       |  4 +---
 CONTRIBUTING.rst    | 12 ++++++------
 DISCLAIMER.txt      |  2 +-
 README.rst          | 11 +++++------
 distill/__init__.py |  2 +-
 pytest.ini          | 12 ++++++++++++
 setup.cfg           |  4 +---
 setup.py            |  9 +++++----
 10 files changed, 61 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/55ae2464/.coveragerc
----------------------------------------------------------------------
diff --git a/.coveragerc b/.coveragerc
new file mode 100644
index 0000000..607377a
--- /dev/null
+++ b/.coveragerc
@@ -0,0 +1,28 @@
+# .coveragerc to control coverage.py
+[run]
+# Measure branch coverage in addition to statement coverage
+branch = True
+source = distill
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+ignore_errors = True
+
+[xml]
+output = coverage.xml
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/55ae2464/AUTHORS.rst
----------------------------------------------------------------------
diff --git a/AUTHORS.rst b/AUTHORS.rst
index 692b03a..fc846b0 100644
--- a/AUTHORS.rst
+++ b/AUTHORS.rst
@@ -31,4 +31,4 @@ Additional Staff
 - Laura Mariano <lm...@apache.org>
 - Dr. Joshua Poore <jp...@apache.org>
 - Clay Gimenez <cg...@dapache.org>
-- Steven York <sy...@draper.com>
\ No newline at end of file
+- Arthi Vezhavendan <av...@apache.org>

http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/55ae2464/CHANGELOG.rst
----------------------------------------------------------------------
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 310115f..fd615c1 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -42,7 +42,6 @@ Changelog
 
 0.0.2 (2016-06-14)
 ------------------
-
 * Completed index route for status endpoint which lists all applications registered and their document count segmented by type.
 * Updated setup.py to reference deploy scripts
 * Example configuration to deploy Distill with Gunicorn and Nginx for Linux/Mac users
@@ -51,5 +50,4 @@ Changelog
 
 0.0.1 (2016-04-01)
 ------------------
-
-Initial alpha release.
\ No newline at end of file
+* Initial alpha release.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/55ae2464/CONTRIBUTING.rst
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 2b08027..e6a9f2e 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -18,10 +18,10 @@
 
 .. _contributing:
 
-Contributing to Apache Distill
-------------------------------
+Contributing to Apache SensSoft
+-------------------------------
 
-Thank you for contributing to the Apache Distill project!
+Thank you for contributing to the Distill project!
 
 There are certain procedures that must be followed for all contributions. These
 procedures are necessary to allow us to allocate resources for reviewing and
@@ -30,7 +30,7 @@ the review process.
 
 1) Create an issue in JIRA
 
-    All changes to Apache Distill must have a corresponding issue in JIRA so the
+    All changes to Distill must have a corresponding issue in JIRA so the
     change can be properly tracked:
 
         https://issues.apache.org/jira/browse/senssoft
@@ -40,7 +40,7 @@ the review process.
 
 2) Make and test your changes locally
 
-    The Apache Distill source is maintained in a git repository hosted on Apache:
+    The Distill source is maintained in a git repository hosted on Apache:
 
         https://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill.git
 
@@ -64,5 +64,5 @@ the review process.
     the corresponding topic branch you created when you began working on your
     changes.
 
-    The Apache Distill team will then review your changes and, if they pass review,
+    The Apache SensSoft team will then review your changes and, if they pass review,
     your changes will be merged.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/55ae2464/DISCLAIMER.txt
----------------------------------------------------------------------
diff --git a/DISCLAIMER.txt b/DISCLAIMER.txt
index 22afb45..fffac59 100644
--- a/DISCLAIMER.txt
+++ b/DISCLAIMER.txt
@@ -1,4 +1,4 @@
-Apache SensSoft Distill is an effort undergoing incubation at The Apache Software Foundation (ASF),
+Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF),
 sponsored by the Apache Incubator project. Incubation is required of all newly accepted
 projects until a further review indicates that the infrastructure, communications, and
 decision making process have stabilized in a manner consistent with other successful

http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/55ae2464/README.rst
----------------------------------------------------------------------
diff --git a/README.rst b/README.rst
index 9262457..a76a72b 100644
--- a/README.rst
+++ b/README.rst
@@ -19,11 +19,10 @@
 Apache SensSoft Distill
 =======================
 
-Apache Distill is part of the `SensSoft <http://sensssoft.incubator.apache.org>`_ software stack. 
-It comprises an analytical engine for `SensSoft UserALE.js <https://github.com/apache/incubator-senssoft-user-ale>`_
-and `SensSoft UserALE.PyQt5 <https://github.com/apache/incubator-senssoft-userale-pyqt5>`_
-to interact with user activity logs and apply basic analtical operations to the data. 
+Distill is part of the `Apache SensSoft <http://sensssoft.incubator.apache.org>`_ project.
+It comprises an analytical engine for `UserALE <http://senssoft.incubator.apache.org/userale/>`_
+to interact with user activity logs and apply basic analytical operations to the data.
 
-Install instructions can be found `here <https://draperlaboratory.github.io/distill/installation.html>`_.
+Install instructions can be found `here <http://senssoft.incubator.apache.org/docs/distill/>`_.
 
-A contribution guide has been provided `here <https://draperlaboratory.github.io/distill/contributing.html>`_.
\ No newline at end of file
+A contribution guide has been provided `here <http://senssoft.incubator.apache.org/docs/contributing.html>`_.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/55ae2464/distill/__init__.py
----------------------------------------------------------------------
diff --git a/distill/__init__.py b/distill/__init__.py
index 009d341..405850a 100644
--- a/distill/__init__.py
+++ b/distill/__init__.py
@@ -20,7 +20,7 @@ from elasticsearch_dsl.connections import connections
 app = Flask(__name__)
 
 # Load Configurations
-app.config.from_pyfile('config.cfg')
+app.config.from_pyfile('config/config.cfg')
 
 # Unpack Elasticsearch configuration and create elasticsearch connection
 host = app.config['ES_HOST']

http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/55ae2464/pytest.ini
----------------------------------------------------------------------
diff --git a/pytest.ini b/pytest.ini
new file mode 100644
index 0000000..eaaf884
--- /dev/null
+++ b/pytest.ini
@@ -0,0 +1,12 @@
+[pytest]
+addopts = -s --strict --pylint --pylint-rcfile=.pylintrc --ignore=build --ignore=dist --ignore=docs --junitxml=test-report.xml
+norecursedirs = docs docker example build *.eggs *env* .git
+testpaths = tests distill
+markers =
+  unit: Unit tests are fast and only test a single module.
+  pylint: Run linter
+  integration: Integration tests integrate several modules or integrate with the OS.
+  interactive: Interactive tests require interaction with the user to complete.
+  requires_user_action: Test cannot run without user interaction.
+  requires_user_validation: Test cannot validate without user interaction, but can run for sanity.
+  only_interactive: This test can only be run in interactive mode.

http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/55ae2464/setup.cfg
----------------------------------------------------------------------
diff --git a/setup.cfg b/setup.cfg
index b854127..e804958 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -24,11 +24,9 @@ daily = egg_info --tag-date sdist
 release = egg_info --tag-build=".rc" sdist bdist_wheel bdist_egg
 
 [tool:pytest] 
-addopts = --verbose --ignore=build --ignore=setup.py --ignore=dist --junitxml=test-report.xml --cov-report xml --cov=distill distill/. 
-norecursedirs = *.eggs *env* .git 
 
 [build_sphinx]
-source-dir = docs
+source-dir = docs/source
 build-dir = docs/_build
 all_files = 1
 

http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/55ae2464/setup.py
----------------------------------------------------------------------
diff --git a/setup.py b/setup.py
index e8814db..c64db18 100644
--- a/setup.py
+++ b/setup.py
@@ -57,8 +57,8 @@ class CleanCommand(setuptools.Command):
         Execute Clean Command
         """
         assert os.getcwd() == self.cwd, 'Must be in package root: %s' % self.cwd
-        os.system('rm -rf ./docs/build ./build ./dist ./*.egg-info')
-        os.system('rm -rf ./*.log html_cov .coverage *.html')
+        os.system('rm -rf ./docs/_build ./build ./dist ./*.egg-info')
+        os.system('rm -rf ./*.log *.xml .coverage *.html')
 
 def read(*filenames, **kwargs):
     encoding = kwargs.get('encoding', 'utf-8')
@@ -88,9 +88,9 @@ setup_requires = [
 
 install_requires = [
     'elasticsearch-dsl >= 5.0.0',
+    'pandas >= 0.20.2',
     'Flask >= 0.12.2',
-    'celery',
-    'pandas',
+    'celery >= 4.0.2',
 ]
 
 tests_require = [
@@ -152,6 +152,7 @@ setuptools.setup(
     setup_requires=setup_requires,
     tests_require=tests_require,
     install_requires=install_requires,
+    extras_require=extras_require,
     entry_points={
         'console_scripts': [
             'dev = distill.server:dev_server'