Took a copy of core for structuring

.gitignore

@@ -1,3 +1,12 @@
+### Ash Added
+
+# Editor
+.idea/
+.editorconfig
+
+### End of Ash adds
+
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -20,7 +29,7 @@ lib64/
 parts/
 sdist/
 var/
-venv/
+wheels/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -43,22 +52,63 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
-*,cover
+*.cover
 .hypothesis/
+.pytest_cache/
 
 # Translations
 *.mo
 *.pot
 
 # Django stuff:
 *.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
 
 # Sphinx documentation
 docs/_build/
 
 # PyBuilder
 target/
 
-#Ipython Notebook
+# Jupyter Notebook
 .ipynb_checkpoints
 
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# pycharm
+.idea

.travis.yml

@@ -1,10 +1,21 @@
 language: python
 python:
+#  - "2.7"
+#   - "3.3"
+#   - "3.4"
   - "3.5"
   - "3.6"
-# command to install dependencies
+#   - "pypy3"
+# commands to install dependencies
 install:
-  - "pip install ."
-  - "pip install -r requirements.txt"
-# command to run tests
+# Needed to get packages on Travis
+#   - "python -m pip install --upgrade pip"
+#   - "pip install numpy"
+#   - "pip install six>=1.11.0"
+# Now install
+  - "python setup.py install"
+#   - "pip install . --process-dependency-links"
+#   - "pip install -r requirements.txt"
+
+# commands to run tests
 script: python setup.py test

AUTHORS.rst

@@ -10,4 +10,16 @@ Maintainer
 Contributors
 ------------
 
-None yet. Why not be the first? See: CONTRIBUTING.rst
+* Stefan Hall
+* Yann Le Norment
+* Adrien Aucher
+
+Want to contribute? See: CONTRIBUTING.rst
+
+Credits
+-------
+
+This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

CONTRIBUTING.rst

@@ -13,7 +13,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/zedrem/coast/issues.
+Report bugs at https://github.com/zedrem/coast_core/issues.
 
 If you are reporting a bug, please include:
 
@@ -35,14 +35,14 @@ is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-coast could always use more documentation, whether
-as part of the official coast docs, in docstrings,
+coast_core could always use more documentation, whether
+as part of the official coast_core docs, in docstrings,
 or even on the web in blog posts, articles, and such.
 
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/zedrem/coast/issues.
+The best way to send feedback is to file an issue at https://github.com/zedrem/coast_core/issues.
 
 If you are proposing a feature:
 
@@ -54,17 +54,17 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `coast` for local development.
+Ready to contribute? Here's how to set up `coast_core` for local development.
 
-1. Fork the `coast` repo on GitHub.
+1. Fork the `coast_core` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone [email protected]:your_name_here/coast.git
+    $ git clone [email protected]:your_name_here/coast_core.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv coast
-    $ cd coast/
+    $ mkvirtualenv coast_core
+    $ cd coast_core/
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -75,7 +75,7 @@ Ready to contribute? Here's how to set up `coast` for local development.
 
 5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
 
-    $ flake8 coast tests
+    $ flake8 coast_core tests
     $ python setup.py test
     $ tox
 
@@ -98,7 +98,6 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
-3. The pull request should work for Python 2.7, 3.3, 3.4, 3.5 and for PyPy. Check
-   https://travis-ci.org/zedrem/coast/pull_requests
+3. The pull request should work for Python 3.3, 3.4, 3.5, 3.6 and for PyPy. Check
+   https://travis-ci.org/zedrem/coast_core/pull_requests
    and make sure that the tests pass for all supported Python versions.
-

HISTORY.rst

@@ -3,4 +3,16 @@
 History
 -------
 
-Pre-release
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| Date               | Status                                                                                                                                          |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| April 2016         | Research on credibility begins, some initial scripts are written as part of various studies                                                     |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| First half of 2017 | Adrien Aucher joins UC as an intern and works with Ashley Williams on the first version of this tool. It is only used internally at this point. |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| April 2018         | Yann Le Norment joins UC as an intern and works on a first public release.                                                                      |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| May 2018           | First public release!                                                                                                                           |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| August 2018        | Version 0.1.2 released; fixing bugs and making things stable.                                                                                   |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+

MANIFEST.in

@@ -8,7 +8,4 @@ recursive-include tests *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
 
-recursive-include docs *.rst conf.py Makefile make.bat
-
-include versioneer.py
-include coast/_version.py
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

Makefile

@@ -1,70 +1,88 @@
-.PHONY: clean-pyc clean-build docs clean
+.PHONY: clean clean-test clean-pyc clean-build docs help
+.DEFAULT_GOAL := help
+
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+
+try:
+	from urllib import pathname2url
+except:
+	from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+
+BROWSER := python -c "$$BROWSER_PYSCRIPT"
 
 help:
-	@echo "clean - remove all build, test, coverage and Python artifacts"
-	@echo "clean-build - remove build artifacts"
-	@echo "clean-pyc - remove Python file artifacts"
-	@echo "clean-test - remove test and coverage artifacts"
-	@echo "lint - check style with flake8"
-	@echo "test - run tests quickly with the default Python"
-	@echo "test-all - run tests on every Python version with tox"
-	@echo "coverage - check code coverage quickly with the default Python"
-	@echo "docs - generate Sphinx HTML documentation, including API docs"
-	@echo "release - package and upload a release"
-	@echo "dist - package"
-	@echo "install - install the package to the active Python's site-packages"
-
-clean: clean-build clean-pyc clean-test
-
-clean-build:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
 	rm -fr build/
 	rm -fr dist/
 	rm -fr .eggs/
 	find . -name '*.egg-info' -exec rm -fr {} +
 	find . -name '*.egg' -exec rm -f {} +
 
-clean-pyc:
+clean-pyc: ## remove Python file artifacts
 	find . -name '*.pyc' -exec rm -f {} +
 	find . -name '*.pyo' -exec rm -f {} +
 	find . -name '*~' -exec rm -f {} +
 	find . -name '__pycache__' -exec rm -fr {} +
 
-clean-test:
+clean-test: ## remove test and coverage artifacts
 	rm -fr .tox/
 	rm -f .coverage
 	rm -fr htmlcov/
+	rm -fr .pytest_cache
 
-lint:
-	flake8 coast tests
+lint: ## check style with flake8
+	flake8 coast_core tests
 
-test:
+test: ## run tests quickly with the default Python
 	python setup.py test
 
-test-all:
+test-all: ## run tests on every Python version with tox
 	tox
 
-coverage:
-	coverage run --source coast_search setup.py test
+coverage: ## check code coverage quickly with the default Python
+	coverage run --source coast_core setup.py test
 	coverage report -m
 	coverage html
-	open htmlcov/index.html
+	$(BROWSER) htmlcov/index.html
 
-docs:
-	rm -f docs/coast.rst
+docs: ## generate Sphinx HTML documentation, including API docs
+	rm -f docs/coast_core.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ coast
+	sphinx-apidoc -o docs/ coast_core
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
-	open docs/_build/html/index.html
+	$(BROWSER) docs/_build/html/index.html
+
+servedocs: docs ## compile the docs watching for changes
+	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
 
-release: clean
-	python setup.py sdist upload
-	python setup.py bdist_wheel upload
+release: dist ## package and upload a release
+	twine upload dist/*
 
-dist: clean
+dist: clean ## builds source and wheel package
 	python setup.py sdist
 	python setup.py bdist_wheel
 	ls -l dist
 
-install: clean
+install: clean ## install the package to the active Python's site-packages
 	python setup.py install