Permalink
Browse files

Added readme file with some docs.

  • Loading branch information...
1 parent 48037b5 commit fc1d32194a1d6dfc4b21e486b43edbcd461f15d6 @ahume committed Dec 7, 2012
Showing with 36 additions and 0 deletions.
  1. +1 −0 .gitignore
  2. +35 −0 README.md
View
@@ -1,2 +1,3 @@
*.pyc
.DS_Store
+.codeintel
View
@@ -0,0 +1,35 @@
+# Politmus API
+#### Prototype Web Service API for Politmus.
+
+The prototype API is written in Python and runs on Google App Engine. There is a live version of the code, including documentation, running on [http://politmus-api.appspot.com](http://politmus-api.appspot.com).
+
+The prototype does not implement any of the authentication features stated in the documentation. Please do not use this to collect real or potentially sensitive data.
+
+#### Local Development
+
+To run the prototype API locally follow these steps.
+
+* Download the [Google App Engine SDK for Python](https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_for_Python) and ensure you install the command-line tools
+
+* Clone the [politmus-api](https://github.com/ahume/politmus-api) Git repository
+
+* `>cd politmus-api/`
+
+* `> dev_appserver.py --use_sqlite app`
+
+This will start the server on [http://localhost:8080](http://localhost:8080). Hit that URL to check it is working - it should redirect you to the documentation pages.
+
+#### Importing Data
+
+Sample data is included in the `fixtures` directory. You can import this data by requesting the following endpoints.
+
+* Import user account data: [http://localhost:8080/import/users](http://localhost:8080/import/users)
+* Import questions and MP data: [http://localhost:8080/import/mpvotes](http://localhost:8080/import/mpvotes) (this may take a few minutes to return!).
+
+
+#### Run the tests
+
+At this point you should be able to run the project's unit tests.
+
+* `> python test/test.py`
+

0 comments on commit fc1d321

Please sign in to comment.