Added Apache License headers and cleaned up documentation.

apache · Sep 19, 2016 · fb6c43a4e6bac829891ab66528a80957f1584c89 · fb6c43a
1 parent 51fc2b6
commit fb6c43a4e6bac829891ab66528a80957f1584c89
Show file tree

Hide file tree

Showing 52 changed files with 853 additions and 222 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 .DS_Store
 
 # Byte-compiled / optimized / DLL files

diff --git a/.travis.yml b/.travis.yml
@@ -1,3 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 language: python
 python:
   - "2.7"

diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -0,0 +1,34 @@
+.. ..
+
+	<!--- Licensed to the Apache Software Foundation (ASF) under one or more
+	contributor license agreements.  See the NOTICE file distributed with
+	this work for additional information regarding copyright ownership.
+	The ASF licenses this file to You under the Apache License, Version 2.0
+	(the "License"); you may not use this file except in compliance with
+	the License.  You may obtain a copy of the License at
+
+	  http://www.apache.org/licenses/LICENSE-2.0
+
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License. 
+	--->
+
+.. _authors:
+
+Apache Distill is written and maintained by Draper and various contributors:
+
+Development Lead
+````````````````
+
+- Michelle Beard <msbeard@apache.org>
+
+Additional Staff
+````````````````
+
+- Laura Mariano <lmariano@apache.org>
+- Dr. Joshua Poore <jpoore@apache.org>
+- Clay Gimenez <cgimenez@dapache.org>
+- Steven York <syork@draper.com>
diff --git a/AUTHORS.txt b/AUTHORS.txt
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -0,0 +1,49 @@
+.. ..
+
+	<!--- Licensed to the Apache Software Foundation (ASF) under one or more
+	contributor license agreements.  See the NOTICE file distributed with
+	this work for additional information regarding copyright ownership.
+	The ASF licenses this file to You under the Apache License, Version 2.0
+	(the "License"); you may not use this file except in compliance with
+	the License.  You may obtain a copy of the License at
+
+	  http://www.apache.org/licenses/LICENSE-2.0
+
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License. 
+	--->
+
+.. _changelog:
+
+Changelog
+=========
+
+0.1.3 (2016-09-19)
+------------------
+* Moved to Apache.
+* Updated all documentation.
+* Added License headers
+* Docker compose file added to assist deployment of ELK stack with Distill
+
+0.1.2 (2016-07-22)
+------------------
+* Moved CRUD operations from UserAle model to Brew model.
+* Added API specs to segment UserAle data from Elasticsearch
+* Added deployment instructions 
+
+0.1.1 (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 Distll with Gunicorn and Nginx for Linux/Mac users
+* Added UserAle and Stout classes.
+* Updated requirements.txt for deployment.
+
+0.1.0 (2016-04-01)
+------------------
+
+Initial release.
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -0,0 +1,68 @@
+.. ..
+
+    <!--- Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License. 
+    --->
+
+.. _contributing:
+
+Contributing to Apache Distill
+------------------------------
+
+Thank you for contributing to the Apache 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
+testing your contribution, as well as to communicate effectively with you during
+the review process.
+
+1) Create an issue in JIRA
+
+    All changes to Apache Distill must have a corresponding issue in JIRA so the
+    change can be properly tracked:
+
+        https://issues.apache.org/jira/browse/senssoft
+
+    If you do not already have an account on JIRA, you will need to create
+    before creating your new issue.
+
+2) Make and test your changes locally
+
+    The Apache Distill source is maintained in a git repository hosted on Apache:
+
+        https://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill.git
+
+    To make your changes, fork the repository and make commits
+    to a topic branch in your fork. Commits should be made in logical units
+    and must reference the JIRA issue number:
+
+    ::
+    
+    	$ git commit -m "#SENSSOFT-123: #High-level message describing the changes."
+
+    Avoid commits which cover multiple, distinct goals that could (and should)
+    be handled separately.
+
+    If you do not already have an account on JIRA, you will need to create
+    one before making your changes.
+
+3) Submit your changes via a pull request on Git
+
+    Once your changes are ready, submit them by creating a pull request for
+    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,
+    your changes will be merged.
diff --git a/LICENSE.txt → LICENSE b/LICENSE.txt → LICENSE
diff --git a/NOTICE b/NOTICE
@@ -0,0 +1,5 @@
+Apache Distill
+Copyright 2016 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
diff --git a/README.rst b/README.rst
@@ -0,0 +1,22 @@
+.. ..
+
+	<!--- Licensed to the Apache Software Foundation (ASF) under one or more
+	contributor license agreements.  See the NOTICE file distributed with
+	this work for additional information regarding copyright ownership.
+	The ASF licenses this file to You under the Apache License, Version 2.0
+	(the "License"); you may not use this file except in compliance with
+	the License.  You may obtain a copy of the License at
+
+	  http://www.apache.org/licenses/LICENSE-2.0
+
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License. 
+	--->
+
+Apache Distill - Under Development
+
+~ What is Apache Distill
+  An analytical engine for Apache UserALE to interact with user activity logs and apply basic analtical operations to the data. 
diff --git a/README.txt b/README.txt
diff --git a/distill/__init__.py b/distill/__init__.py
@@ -1,3 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from flask import Flask
 from elasticsearch_dsl.connections import connections
 

diff --git a/distill/algorithms/__init__.py b/distill/algorithms/__init__.py
@@ -0,0 +1,14 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
diff --git a/distill/algorithms/graphs/__init__.py b/distill/algorithms/graphs/__init__.py
@@ -0,0 +1,14 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
diff --git a/distill/algorithms/graphs/graph.py b/distill/algorithms/graphs/graph.py
@@ -1,3 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 class GraphAnalytics (object):
 	"""
 	Distill's graph analytics package. Apply graph algorithms to User Ale log data segmented with

diff --git a/distill/algorithms/graphs/tests/__init__.py b/distill/algorithms/graphs/tests/__init__.py
@@ -1,3 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 '''
 distill: tests module.
 

diff --git a/distill/algorithms/stats/__init__.py b/distill/algorithms/stats/__init__.py
@@ -0,0 +1,14 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
diff --git a/distill/algorithms/stats/hist.py b/distill/algorithms/stats/hist.py
@@ -1,3 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from distill import es
 from distill.utils.query_builder import QueryBuilder
 from flask import jsonify