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


Download files

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

Source Distribution

qiita-0.1.1.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

qiita-0.1.1-py2.7.egg (11.7 kB view details)

Uploaded Source

File details

Details for the file qiita-0.1.1.tar.gz.

File metadata

  • Download URL: qiita-0.1.1.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for qiita-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b24ef39314f7e0529422726b7fab776dd68b8f9b6cd39e1c98d9bf954cedd3e7
MD5 e324449d974e4f03537ad5268fbfd35a
BLAKE2b-256 d5947aca80954a2a49bf76742070f42370876ae3c73ef646e1bf65d67287699f

See more details on using hashes here.

File details

Details for the file qiita-0.1.1-py2.7.egg.

File metadata

  • Download URL: qiita-0.1.1-py2.7.egg
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for qiita-0.1.1-py2.7.egg
Algorithm Hash digest
SHA256 eac6ca819334fe33dc3f18ae65a3b6b57dcf24c1723b483b3ef2b0baf12c29c9
MD5 b8acd6203c4746b3d47702da414ceb04
BLAKE2b-256 bef29d861e18599e682f95d3c38b6f3d3fdb8be9f694d8de664ff65bcc28b5bc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page