diff --git a/.idea/ghdata.iml b/.idea/ghdata.iml deleted file mode 100644 index 2840575746..0000000000 --- a/.idea/ghdata.iml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml deleted file mode 100644 index c23ecacb3a..0000000000 --- a/.idea/inspectionProfiles/profiles_settings.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml deleted file mode 100644 index 70858dae0a..0000000000 --- a/.idea/misc.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index f5ce7fce39..0000000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 94a25f7f4c..0000000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml deleted file mode 100644 index ae6af72dea..0000000000 --- a/.idea/workspace.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - true - DEFINITION_ORDER - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1496672641274 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/.pytest_cache/v/cache/lastfailed b/.pytest_cache/v/cache/lastfailed deleted file mode 100644 index 198aab879f..0000000000 --- a/.pytest_cache/v/cache/lastfailed +++ /dev/null @@ -1,16 +0,0 @@ -{ - "frontend/node_modules/node-gyp/gyp/pylib/gyp/MSVSSettings_test.py": true, - "frontend/node_modules/node-gyp/gyp/pylib/gyp/common_test.py": true, - "frontend/node_modules/node-gyp/gyp/pylib/gyp/easy_xml_test.py": true, - "frontend/node_modules/node-gyp/gyp/pylib/gyp/generator/msvs_test.py": true, - "frontend/node_modules/node-gyp/gyp/pylib/gyp/generator/ninja_test.py": true, - "frontend/node_modules/node-gyp/gyp/pylib/gyp/generator/xcode_test.py": true, - "frontend/node_modules/node-gyp/gyp/pylib/gyp/input_test.py": true, - "frontend/node_modules/npm/node_modules/node-gyp/gyp/pylib/gyp/MSVSSettings_test.py": true, - "frontend/node_modules/npm/node_modules/node-gyp/gyp/pylib/gyp/common_test.py": true, - "frontend/node_modules/npm/node_modules/node-gyp/gyp/pylib/gyp/easy_xml_test.py": true, - "frontend/node_modules/npm/node_modules/node-gyp/gyp/pylib/gyp/generator/msvs_test.py": true, - "frontend/node_modules/npm/node_modules/node-gyp/gyp/pylib/gyp/generator/ninja_test.py": true, - "frontend/node_modules/npm/node_modules/node-gyp/gyp/pylib/gyp/generator/xcode_test.py": true, - "frontend/node_modules/npm/node_modules/node-gyp/gyp/pylib/gyp/input_test.py": true -} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index abeffd5f56..c3c049a03e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ We love pull requests from everyone. Fork, then clone the repo: - git clone git@github.com:your-username/ghdata.git + git clone git@github.com:your-username/augur.git Make your change and push to your fork. Then, [submit a pull request][pr]. diff --git a/Dockerfile b/Dockerfile index 4b46dc781d..4990226a29 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,7 +7,7 @@ ENV STATIC_INDEX 1 COPY ./docker/uwsgi.ini /app/uwsgi.ini COPY ./frontend/public /app/static -RUN mkdir /ghdata -WORKDIR /ghdata -ADD . /ghdata +RUN mkdir /augur +WORKDIR /augur +ADD . /augur RUN pip install --upgrade . \ No newline at end of file diff --git a/Makefile b/Makefile index 654967bc3d..ffc22211d2 100644 --- a/Makefile +++ b/Makefile @@ -6,20 +6,20 @@ PY3 := $(shell command -v pip3 2> /dev/null) NODE := $(shell command -v npm 2> /dev/null) CONDA := $(shell command -v conda 2> /dev/null) -SERVECOMMAND=gunicorn -w`getconf _NPROCESSORS_ONLN` -b0.0.0.0:5000 ghdata.server:app +SERVECOMMAND=gunicorn -w`getconf _NPROCESSORS_ONLN` -b0.0.0.0:5000 augur.server:app CONDAUPDATE="" CONDAACTIVATE="" ifdef CONDA - CONDAUPDATE=if ! source activate ghdata; then conda env create -n=ghdata -f=environment.yml && source activate ghdata; else conda env update -n=ghdata -f=environment.yml && source activate ghdata; fi; - CONDAACTIVATE=source activate ghdata; + CONDAUPDATE=if ! source activate augur; then conda env create -n=augur -f=environment.yml && source activate augur; else conda env update -n=augur -f=environment.yml && source activate augur; fi; + CONDAACTIVATE=source activate augur; endif default: @ echo "Commands:" @ echo - @ echo " install Installs ghdata using pip" - @ echo " install-dev Installs ghdata's developer dependencies (requires npm and pip)" + @ echo " install Installs augur using pip" + @ echo " install-dev Installs augur's developer dependencies (requires npm and pip)" @ echo " install-msr Installs MSR14 dataset" @ echo " upgrade Pulls newest version and installs" @ echo " test Run pytest unit tests" @@ -74,7 +74,7 @@ ugh: dev-start: dev-stop ifdef CONDA @ bash -c '(cd frontend; brunch w -s >../logs/frontend.log 2>&1 & echo $$! > ../logs/frontend.pid);' - @ bash -c '(source activate ghdata; $(SERVECOMMAND) >logs/backend.log 2>&1 & echo $$! > logs/backend.pid);' + @ bash -c '(source activate augur; $(SERVECOMMAND) >logs/backend.log 2>&1 & echo $$! > logs/backend.pid);' else @ bash -c '(cd frontend; brunch w -s >../logs/frontend.log 2>&1 & echo $$! > ../logs/frontend.pid);' @ bash -c '($(SERVECOMMAND) >logs/backend.log 2>&1 & echo $$! > logs/backend.pid);' @@ -82,7 +82,7 @@ endif @ echo "Server Description Log Monitoring PID " @ echo "------------------------------------------------------------------------------------------ " @ echo "Frontend Brunch logs/frontend.log make monitor-backend $$( cat logs/frontend.pid ) " - @ echo "Backend GHData/Gunicorn logs/backend.log make monitor-frontend $$( cat logs/backend.pid ) " + @ echo "Backend Augur/Gunicorn logs/backend.log make monitor-frontend $$( cat logs/backend.pid ) " @ echo @ echo "Monitor both: make monitor " @ echo "Restart and monitor: make dev" @@ -113,7 +113,7 @@ serve: ifdef CONDA bash -c "$(SERVECOMMAND)" else - gunicorn -w`getconf _NPROCESSORS_ONLN` -b0.0.0.0:5000 ghdata.server:app + gunicorn -w`getconf _NPROCESSORS_ONLN` -b0.0.0.0:5000 augur.server:app endif python-docs: @@ -122,12 +122,12 @@ python-docs: && make html api-docs: - apidoc --debug -f "\.py" -i ghdata/ -o docs/api/ + apidoc --debug -f "\.py" -i augur/ -o docs/api/ docs: api-docs python-docs build: docs - cd ghdata/static/ && brunch build --production + cd augur/static/ && brunch build --production check-test-env: ifndef DB_TEST_URL diff --git a/README.md b/README.md index 1cff698bb7..e9555b1163 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ -# GHData +# Augur branch | status --- | --- -master | [![Build Status](https://travis-ci.org/OSSHealth/ghdata.svg?branch=master)](https://travis-ci.org/OSSHealth/ghdata) - dev | [![Build Status](https://travis-ci.org/OSSHealth/ghdata.svg?branch=dev)](https://travis-ci.org/OSSHealth/ghdata) +master | [![Build Status](https://travis-ci.org/OSSHealth/augur.svg?branch=master)](https://travis-ci.org/OSSHealth/augur) + dev | [![Build Status](https://travis-ci.org/OSSHealth/augur.svg?branch=dev)](https://travis-ci.org/OSSHealth/augur) -GHData is a Python library and REST server that provides data related to GitHub repositories. Hosting the GHData project requires a copy of the [GHTorrent database](http://ghtorrent.org/downloads.html). +Augur is a Python library and REST server that provides data related to GitHub repositories. Hosting the Augur project requires a copy of the [GHTorrent database](http://ghtorrent.org/downloads.html). -GHData is under heavy development; expect frequent backwards-incompatible changes until a 1.x.x release! +Augur is under heavy development; expect frequent backwards-incompatible changes until a 1.x.x release! Roadmap ------- -Our technical, outreach, and academic goals [roadmap](https://github.com/OSSHealth/ghdata/wiki/Release-Schedule). +Our technical, outreach, and academic goals [roadmap](https://github.com/OSSHealth/augur/wiki/Release-Schedule). @@ -26,8 +26,8 @@ Now, to install: 1. Clone the repo and enter its directory: ```bash - git clone https://github.com/OSSHealth/ghdata - cd ghdata + git clone https://github.com/OSSHealth/augur + cd augur ``` @@ -35,24 +35,24 @@ Now, to install: ```bash # Most likely required - GHDATA_DB_USER - GHDATA_DB_PASS - GHDATA_DB_HOST - GHDATA_DB_PORT - GHDATA_DB_NAME + AUGUR_DB_USER + AUGUR_DB_PASS + AUGUR_DB_HOST + AUGUR_DB_PORT + AUGUR_DB_NAME # Optional - GHDATA_HOST - GHDATA_PORT - GHDATA_PUBLIC_WWW_API_KEY - GHDATA_GITHUB_API_KEY - GHDATA_LIBRARIESIO_API_KEY - GHDATA_DEBUG - GHDATA_GHTORRENT_PLUS_USER - GHDATA_GHTORRENT_PLUS_PASS - GHDATA_GHTORRENT_PLUS_HOST - GHDATA_GHTORRENT_PLUS_PORT - GHDATA_GHTORRENT_PLUS_NAME + AUGUR_HOST + AUGUR_PORT + AUGUR_PUBLIC_WWW_API_KEY + AUGUR_GITHUB_API_KEY + AUGUR_LIBRARIESIO_API_KEY + AUGUR_DEBUG + AUGUR_GHTORRENT_PLUS_USER + AUGUR_GHTORRENT_PLUS_PASS + AUGUR_GHTORRENT_PLUS_HOST + AUGUR_GHTORRENT_PLUS_PORT + AUGUR_GHTORRENT_PLUS_NAME ``` docker-compose will automatically pass the relevant variables from the local environment to the container. @@ -74,18 +74,18 @@ Installation without Docker (recommended for developers) - If you want to install your own copy of the MSR14 dataset [Installation instructions](https://github.com/gousiosg/github-mirror/tree/master/sql) - a MySQL 5.x database with write access -After restoring GHTorrent (or msr14) to MySQL, it is recommended you create a user for GHData. GHData only needs `SELECT` privileges. +After restoring GHTorrent (or msr14) to MySQL, it is recommended you create a user for Augur. Augur only needs `SELECT` privileges. -Once the database is set up, clone GHData +Once the database is set up, clone Augur ```bash -git clone https://github.com/OSSHealth/ghdata/ -cd ghdata && pip install -U . +git clone https://github.com/OSSHealth/augur/ +cd augur && pip install -U . ``` -Copy the files in [ghdata repo]/frontend/public to your webserver: +Copy the files in [augur repo]/frontend/public to your webserver: -Run `ghdata` to create the configuration file (ghdata.cfg). Edit the file to reflect your database credentials. +Run `augur` to create the configuration file (augur.cfg). Edit the file to reflect your database credentials. -Run `ghdata` to start the backend. Visit your front +Run `augur` to start the backend. Visit your front Developer Installation @@ -110,7 +110,7 @@ Developer Installation First, clone the repo and checkout the dev branch: ```bash -git clone https://github.com/OSSHealth/ghdata/ && cd ghdata && git checkout dev +git clone https://github.com/OSSHealth/augur/ && cd augur && git checkout dev ``` Install the Python and Node developer dependencies: @@ -118,7 +118,7 @@ Install the Python and Node developer dependencies: make install-dev ``` -For futher instructions on how to add to GHData, here are guides to adding an endpoint to the full stack. +For futher instructions on how to add to Augur, here are guides to adding an endpoint to the full stack. [Dev Guide Part 1](docs/dev-guide-pt1.md) @@ -126,7 +126,7 @@ For futher instructions on how to add to GHData, here are guides to adding an en Frontend development guide coming soon! -You're good to go. You can start a single instance of the API by running `ghdata`. Run `make dev-start` to start both the Brunch server and Gunicorn server for full-stack development. +You're good to go. You can start a single instance of the API by running `augur`. Run `make dev-start` to start both the Brunch server and Gunicorn server for full-stack development. The screen sessions can be killed with `make dev-stop` @@ -134,6 +134,6 @@ License and Copyright --------------------- Copyright © 2018 University of Nebraska at Omaha, University of Missouri and CHAOSS Project at the Linux Foundation -GHData is free software: you can redistribute it and/or modify it under the terms of the MIT License as published by the Open Source Initiative. See the file [LICENSE](LICENSE) for more details. +Augur is free software: you can redistribute it and/or modify it under the terms of the MIT License as published by the Open Source Initiative. See the file [LICENSE](LICENSE) for more details. (This work has been funded through the Alfred P. Sloan Foundation) diff --git a/apidoc.json b/apidoc.json index c45716f3dd..cb4126f556 100644 --- a/apidoc.json +++ b/apidoc.json @@ -1,7 +1,7 @@ { - "name": "GHData API", + "name": "Augur API", "version": "0.0.2", "description": "REST API for Health and Sustainability Metrics", - "title": "GHData API", + "title": "Augur API", "url" : "http://localhost:5000/api/unstable" } \ No newline at end of file diff --git a/ghdata/.idea/ghdata.iml b/augur/.idea/ghdata.iml similarity index 100% rename from ghdata/.idea/ghdata.iml rename to augur/.idea/ghdata.iml diff --git a/ghdata/.idea/misc.xml b/augur/.idea/misc.xml similarity index 100% rename from ghdata/.idea/misc.xml rename to augur/.idea/misc.xml diff --git a/ghdata/.idea/modules.xml b/augur/.idea/modules.xml similarity index 55% rename from ghdata/.idea/modules.xml rename to augur/.idea/modules.xml index f5ce7fce39..90c5d83ab0 100644 --- a/ghdata/.idea/modules.xml +++ b/augur/.idea/modules.xml @@ -2,7 +2,7 @@ - + \ No newline at end of file diff --git a/ghdata/.idea/workspace.xml b/augur/.idea/workspace.xml similarity index 98% rename from ghdata/.idea/workspace.xml rename to augur/.idea/workspace.xml index 4b9e8ff0f6..98b049bc25 100644 --- a/ghdata/.idea/workspace.xml +++ b/augur/.idea/workspace.xml @@ -48,8 +48,8 @@ - - + +