Skip to main content

Qiita api wrapper for Python

Project description

Python wrapper for Qiita API v1.

https://secure.travis-ci.org/heavenshell/py-qiita.png

Installation

$ virtualenv --distribute qiita_sample
$ source qiita_sample/bin/activate
$ cd qiita_sample
$ pip install qiita

Qiita depends on Requests.

Usage

Get user’s items

# -*- coding: utf-8 -*-
from qiita import Items

client = Items()
items = client.user_items('heavenshell')

Get tag’s items

# -*- coding: utf-8 -*-
from qiita import Tags

client = Tags()
items = client.tag_items('python')

Get a specified item with comments and raw markdown content

# -*- coding: utf-8 -*-
from qiita import Items

client = Items()
item_uuid = '1234567890abcdefg'
items = client.item(item_uuid)

Authenticated requests

Login with “username & password” or “token”

# -*- coding: utf-8 -*-
from qiita import Client

client = Client(url_name='heavenshell', password='mysecret')
token = client.token # => contains token
# or
client = Client(token='myauthtoken')

Get my items

# -*- coding: utf-8 -*-
from qiita import Items

client = Client(token='myauthtoken')
items = client.user_item()

Post/Update/Delete an item

# -*- coding: utf-8 -*-
from qiita import Items

client = Client(token='myauthtoken')
params = {
  'title': 'Hello',
  'body': 'markdown text',
  'tags': [{name: 'python', versions: ['2.6', '2.7']}],
  'private': False
}
# post
item = client.post_item(params)

# update
params['title'] = 'modified'
client.update_item(item['uuid'], params)

# delete
client.delete_item(item['uuid'])

Stock/Unstock item

# -*- coding: utf-8 -*-
from qiita import Items

client = Items(token='myauthtoken')
item_uuid = '1489e2b291fed74713b2'
# Stock
client.stock_item(item_uuid)

# Unstock
client.unstock_item(item_uuid)

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am ‘Add some feature’)
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Project details


Release history Release notifications

This version
History Node

0.1.1

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
qiita-0.1.1-py2.7.egg (11.7 kB) Copy SHA256 hash SHA256 Egg 2.7 Oct 22, 2012
qiita-0.1.1.tar.gz (13.5 kB) Copy SHA256 hash SHA256 Source None Oct 22, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page