diff --git a/.gitignore b/.gitignore index 7b713f6..bf2f680 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ -*~ +.gitignore +.project +.pydevproject +.settings +google_api_key.txt +static/js/d3.js *.pyc -.idea \ No newline at end of file diff --git a/README.rst b/README.rst index 0148fb7..6f866c7 100644 --- a/README.rst +++ b/README.rst @@ -4,12 +4,14 @@ api-client-python Getting started --------------- -This Python client provides a simple web application which fetches data from the +This Python client demonstrates a simple web-based genome browser that fetches data from the `Google Genomics API`_, the NCBI Genomics API or the Local Readstore through a web -interface. +interface, and displays a pileup of reads with support for zooming and basic navigation and search. + +You can try out the sample genome browser, called GABrowse, now by going to https://gabrowse.appspot.com. It can be run with app engine or without. -See `the docs `_ +See `the docs `_ for more information. .. _Google Genomics Api: https://developers.google.com/genomics @@ -48,29 +50,23 @@ Then install the required dependencies and run the ``localserver.py`` file:: Enabling the Google API ~~~~~~~~~~~~~~~~~~~~~~~ -If you want to pull in data from `Google Genomics API`_ you will need to set -``API_KEY`` in ``main.py`` to a valid Google API key. - -* First apply for access to the Genomics API by following the instructions at - https://developers.google.com/genomics/ +If you want to pull in data from `Google Genomics API`_ you will need to store a valid +Google API key into a file named ``google_api_key.txt``. -* Then create a project in the - `Google Developers Console `_ - or select an existing one. +* First create a `Genomics enabled project `_ + in the Google Developers Console. -* On the **APIs & auth** tab, select APIs and turn the Genomics API to ON - -* On the **Credentials** tab, click **create new key** under +* Once you are redirected to the **Credentials** tab, click **create new key** under the Public API access section. * Select **Server key** in the dialog that pops up, and then click **Create**. (You don't need to enter anything in the text box) * Copy the **API key** field value that now appears in the Public API access - section into the top of ``main.py``. It should look something like this:: - - API_KEY = "abcdef12345abcdef" + section into a new file named ``google_api_key.txt`` in the same directory as ``main.py``. + The file should consist of a single undecorated line like this:: + abcdef12345abcdef Note: You can also reuse an existing API key if you have one. Just make sure the Genomics API is turned on. @@ -152,12 +148,11 @@ from any API provider. It deploys on App Engine (to meet the Awesome possible features include: -* Incorporating variant data into the UI. * Add more information to the read display (show inserts, highlight mismatches against the reference, etc) * Possibly cleaning up the js code to be more plugin friendly - so that pieces could be shared and reused (d3 library? jquery plugin?) * Staying up to date on API changes (readset searching now has pagination, etc) -* Better searching of Snpedia (or another provider) +* Better searching of Snpedia (or another provider - EBI?) * Other enhancement ideas are very welcome * (for smaller/additional tasks see the GitHub issues) diff --git a/main.html b/main.html index 0564556..3e300ca 100644 --- a/main.html +++ b/main.html @@ -23,11 +23,13 @@ + + @@ -51,13 +53,13 @@ -