Skip to content

Commit

Permalink
add separate readme for server
Browse files Browse the repository at this point in the history
  • Loading branch information
yarl committed Mar 13, 2017
1 parent 218dee8 commit 160a201
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
A small python server providing authorization for edit actions on Wikidata.

### Local setup

1. Install python requirements

```bash
pip install -r requirements.txt
```

2. Setup config.yaml

Copy config.default.yaml to config.local.yaml. You may need to add oauth consumer info, which you can apply for [here](https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose). If you need a set of keys for testing purposes (running on localhost:5000), you can email me at <[email protected]>.

3. Run the dev server

```bash
python monumental/server.py
```

Test it out:

- Login: http://localhost:5000/login
- A simple Wikidata API query: http://localhost:5000/api?action=query&list=random&rnnamespace=0&rnlimit=10
- Get an edit token (with authorization): http://localhost:5000/api?action=query&meta=tokens&use_auth=true

See [here](https://www.wikidata.org/w/api.php) for full Wikidata API docs.

0 comments on commit 160a201

Please sign in to comment.