https://github.com/davidvuong/pynodebb

PyNodeBB is a Python client for the NodeBB API
https://github.com/davidvuong/pynodebb

Last synced: 23 days ago
JSON representation

PyNodeBB is a Python client for the NodeBB API

• Host: GitHub
• URL: https://github.com/davidvuong/pynodebb
• Owner: davidvuong
• License: mit
• Created: 2015-09-17T05:29:08.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-10T06:18:47.000Z (almost 9 years ago)
• Last Synced: 2024-05-30T02:30:26.800Z (5 months ago)
• Language: Python
• Homepage:
• Size: 294 KB
• Stars: 2
• Watchers: 3
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Welcome to pyNodeBB

[![Build Status](https://travis-ci.org/davidvuong/pynodebb.svg?branch=master)](https://travis-ci.org/davidvuong/pynodebb)

[![Coverage Status](https://coveralls.io/repos/davidvuong/pynodebb/badge.svg?branch=master&service=github)](https://coveralls.io/github/davidvuong/pynodebb?branch=master)

[![Code Climate](https://codeclimate.com/github/davidvuong/pynodebb/badges/gpa.svg)](https://codeclimate.com/github/davidvuong/pynodebb)

[![PyPI version](https://badge.fury.io/py/pynodebb.svg)](http://badge.fury.io/py/pynodebb)

[![Documentation Status](https://readthedocs.org/projects/pynodebb/badge/?version=latest)](https://readthedocs.org/projects/pynodebb/?badge=latest)

pyNodeBB is a Python client for the NodeBB API (still under development).

### Install

```

pip install pynodebb

```

### Getting started

```python

from __future__ import print_function

from pynodebb import Client

client = Client('http://localhost:4567', 'master_token')

client.configure(**{

  'page_size': 20

})

# Retrieves a NodeBB user given their `uid`.

status_code, user = client.users.get(uid)

print(user['username'])

# Updates the retrieved user's `fullname`.

client.users.update(user['uid'], **{'fullname': 'David Vuong'})

# Iterate over all topics in category given the `cid`.

status_code, topics = client.topics.list(1):

for topic in topics:

    print(topic['title'])

```

### Documentation

Documentation is available at http://pynodebb.readthedocs.org/en/latest/.

### License

[MIT](https://github.com/davidvuong/pynodebb/blob/master/LICENSE.md)