upload files

LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2017, Xianglong Tao
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. All advertising materials mentioning features or use of this software
+   must display the following acknowledgement:
+   This product includes software developed by the <organization>.
+4. Neither the name of the <organization> nor the
+   names of its contributors may be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY Xianglong Tao ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL Xianglong Tao BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.rst

@@ -0,0 +1,45 @@
+======
+findQA
+======
+
+findQA is a Django command that enables users to search for testers based on
+the country(s) and device(s) the user specifies.  The command output includes
+the following fields formatted as CSV: the tester's first name, last name,
+country code, and experience (which is how many bugs the tester has spotted
+based on the searching criteria).
+
+This is version 0.1.1 of this app.
+
+Quick start
+-----------
+
+1. Check the requirements for this app in requirement.txt in 'findQA/requirements.txt'
+   `pip freeze > requirements.txt`
+   If you wish to install all required libraries, simply run
+   `pip install -r requirements.txt`
+
+2. In matchQA/matchQA/settings.py, make sure the app has been added to INSTALLED_APPS, such as
+    INSTALLED_APPS = [
+    'findQA.apps.FindQAConfig',
+    ...]
+
+3. Run `python manage.py migrate` to create the findQA tables in the database.
+
+4. Run `python manage.py shell < load_data.py` to insert all data from matchQA/matchQA/csv_data
+   into database.
+
+5. Run `python manage.py find_testers -h` to view the command's help.
+   Examples:
+    * If you wish to search by all countries and device
+    `python manage.py find_testers`
+
+    * If you wish to search by country(s)
+    `python manage.py find_testers -c US,JP`
+
+    * If you wish to search by device(s), please make sure enclose each device's name in single quotes.
+    `python manage.py find_testers -d 'iPhone 4','iPhone 4S'`
+
+    * If you wish to search by countries and device(s).
+    `python manage.py find_testers -c US,JP -d 'iPhone 4','iPhone 4S'`
+
+5b. [OPTIONAL] Run `python manage.py test` to run unit tests to against the code.