Skip to content
Permalink
Browse files
#SENSSOFT-193: Updated documentation and test runners
  • Loading branch information
michellebeard committed Jun 22, 2017
1 parent cf3a795 commit 55ae2464416739a703522aaf3964dee56b41edde
Show file tree
Hide file tree
Showing 10 changed files with 61 additions and 25 deletions.
@@ -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
@@ -31,4 +31,4 @@ Additional Staff
- Laura Mariano <lmariano@apache.org>
- Dr. Joshua Poore <jpoore@apache.org>
- Clay Gimenez <cgimenez@dapache.org>
- Steven York <syork@draper.com>
- Arthi Vezhavendan <avezhavendan@apache.org>
@@ -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.
* Initial alpha release.
@@ -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.
@@ -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
@@ -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>`_.
A contribution guide has been provided `here <http://senssoft.incubator.apache.org/docs/contributing.html>`_.
@@ -20,7 +20,7 @@
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']
@@ -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.
@@ -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

@@ -57,8 +57,8 @@ def run(self):
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 @@ def get_version():

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 @@ def get_version():
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'

0 comments on commit 55ae246

Please sign in to comment.