Repository: incubator-senssoft-distill Updated Branches: refs/heads/master 51fc2b633 -> e55816742
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/fb6c43a4/docs/source/installation.rst ---------------------------------------------------------------------- diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 17cd6fd..9947fde 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,18 +1,36 @@ +.. .. + + <!--- 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. + ---> + .. _installation: Installation Guide ================== -Installing Distill ------------------- +Installing Apache Distill +------------------------- -The first step is to install Distill. First, checkout the latest version of Distill. +The first step is to install Apache Distill. First, checkout the latest version of Apache Distill. :: - $ git clone https://github.com/draperlaboratory/distill.git + $ git clone https://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill.git -Distill is a python project, so it can be installed like any other python library. Several operating systems (Mac OS X, Major Versions of Linux/BSD) have Python pre-installed, so you should just have to run +Apache Distill is a python project, so it can be installed like any other python library. Several operating systems (Mac OS X, Major Versions of Linux/BSD) have Python pre-installed, so you should just have to run :: @@ -24,24 +42,24 @@ or $ pip install distill -Users are strongly recommended to install Distill in a virtualenv. Instructions to setup an virtual environment will be explained below. +Users are strongly recommended to install Apache Distill in a virtualenv. Instructions to setup an virtual environment will be explained below. .. note :: When the package is installed via ``easy_install`` or ``pip`` this function will be bound to the ``distill`` executable in the Python installation's ``bin`` directory (on Windows - the ``Scripts`` directory). -Installing Distill in an Virtual Environment --------------------------------------------- +Installing Apache Distill in an Virtual Environment +--------------------------------------------------- -virtualenv is a tool to create isolated Python environments. virtualenv creates a folder which contains all the necessary executables to use the packages that the Distill project would need. +virtualenv is a tool to create isolated Python environments. virtualenv creates a folder which contains all the necessary executables to use the packages that the Apache Distill project would need. Install virtualenv via pip: :: - $ sudo pip install virtualenv + $ sudo env/bin/pip install virtualenv -Start by changing directory into the root of Distill's project directory, and then use the virtualenv command-line tool to create a new environment: +Start by changing directory into the root of Apache Distill's project directory, and then use the virtualenv command-line tool to create a new environment: :: @@ -54,7 +72,7 @@ Activate environment: $ source env/bin/activate -Install Distill requirements: +Install Apache Distill requirements: :: @@ -66,7 +84,7 @@ To build the source code and run all unit tests. $ env/bin/python setup.py develop test -Launch local Distill server, running on localhost:8090: +Launch local Apache Distill server, running on localhost:8090: :: @@ -81,7 +99,7 @@ Deactivate environment Deployment ---------- -I will describe a setup with nginx as a web server on Ubuntu. A web server cannot communicate directly with a Flask application such as Distill, thatâs why gunicorn will be used to act as a medium between the web server and Distill. Gunicorn is like an application web server that will be running behind nginx, and it is WSGI compatible. It can communicate with applications that support WSGI â Flask, Django, etc. +I will describe a setup with nginx as a web server on Ubuntu. A web server cannot communicate directly with a Flask application such as Apache Distill. Thus gunicorn will be used to act as a medium between the web server and Apache Distill. Gunicorn is like an application web server that will be running behind nginx, and it is WSGI compatible. It can communicate with applications that support WSGI â Flask, Django, etc. Install requirements. @@ -100,15 +118,15 @@ Download the project from the GitHub repository and copy the application to the :: - $ git clone https://github.com/draperlaboratory/distill.git /home/public_html + $ git clone https://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill.git /home/public_html -Install Distill's requirements either globally or in a virutal environment: +Install Apache Distill's requirements either globally or in a virutal environment: :: - $ pip install -r requirements.txt + $ env/bin/pip install -r requirements.txt -Distill has provided an nginx configuration file located in ``distill/deploy/nginx.conf``. +Apache Distill has provided an nginx configuration file located in ``distill/deploy/nginx.conf``. Gunicorn will use port 8000 and handle the incoming HTTP requests. @@ -133,7 +151,13 @@ To save yourself the trouble, all up to date documentation is available at https However, if you want to manully build the documentation, the instructions are below. -To build Distill's documentation, create a directory at the root level of ``/distill`` called distill-docs. +First, install the documentation dependencies: + +:: + + $ env/bin/pip install -r doc_requirements.txt + +To build Apache Distill's documentation, create a directory at the root level of ``/distill`` called distill-docs. :: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/fb6c43a4/docs/source/license.rst ---------------------------------------------------------------------- diff --git a/docs/source/license.rst b/docs/source/license.rst index d31cf73..381ed53 100644 --- a/docs/source/license.rst +++ b/docs/source/license.rst @@ -1,13 +1,32 @@ +.. .. + + <!--- 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. + ---> + License ======= -Copyright 2016 The Charles Stark Draper Laboratory, Inc. - -Licensed 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 +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 + 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, http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/fb6c43a4/docs/source/quickstart.rst ---------------------------------------------------------------------- diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index fdac9cd..67ff2fc 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -1,3 +1,21 @@ +.. .. + + <!--- 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. + ---> + .. _quickstart: Quickstart Guide http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/fb6c43a4/manual.pdf ---------------------------------------------------------------------- diff --git a/manual.pdf b/manual.pdf deleted file mode 100644 index 0e7c94b..0000000 Binary files a/manual.pdf and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/fb6c43a4/requirements.txt ---------------------------------------------------------------------- diff --git a/requirements.txt b/requirements.txt index 72527ed..f759856 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +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. + Flask==0.10.1 networkx==1.11 elasticsearch-dsl==2.0.0 numpy>=1.10.0 scipy>=0.17.0 -sphinx>=1.4.0 pandas>=0.18.1 -pytest>=2.9.0 -sphinx_rtd_theme>=0.1.9 \ No newline at end of file +pytest>=2.9.0 \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/fb6c43a4/setup.cfg ---------------------------------------------------------------------- diff --git a/setup.cfg b/setup.cfg index 2a77aac..daaed8a 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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. + [egg_info] tag_build = 1.0 tag_svn_revision = false http://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill/blob/fb6c43a4/setup.py ---------------------------------------------------------------------- diff --git a/setup.py b/setup.py index 6b7512c..ccf0855 100644 --- a/setup.py +++ b/setup.py @@ -1,12 +1,11 @@ -# -*- coding: utf-8 -*- +# 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 # -# Copyright 2016 The Charles Stark Draper Laboratory, Inc. -# -# Licensed 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 +# 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, @@ -48,9 +47,18 @@ class PyTest (TestCommand): import pytest # import here, because outside the required eggs aren't loaded yet sys.exit (pytest.main (self.test_args)) +# Get the version string +def get_version (): + basedir = os.path.dirname (__file__) + with open (os.path.join (basedir, 'distill/version.py')) as f: + version = {} + exec (f.read (), version) + return version['__version__'] + raise RuntimeError ('No version info found.') + setup ( name = "Distill", - version = "1.0", + version = get_version (), url = "https://github.com/draperlaboratory/distill";, license = "Apache Software License", author = "Michelle Beard",
