Skip to content

Commit

Permalink
docs(readme): simplified readme, add docs badge
Browse files Browse the repository at this point in the history
  • Loading branch information
davidvuong committed Nov 5, 2015
1 parent 0b8e211 commit 431d102
Showing 1 changed file with 2 additions and 40 deletions.
42 changes: 2 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,10 @@
[![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 and setup

1. Install NodeBB. Currently this wrapper only supports 0.7.3 so you'll need to clone from the `0.7.x` branch. Follow the install guide [here](https://docs.nodebb.org/en/latest/installing/os.html).
1. Install the `nodebb-plugin-write-api`. Unfortunately NodeBB only has a read-api and a write-api needs to be installed separately:

```
cd /path/to/nodebb/node_modules/
git clone [email protected]:davidvuong/nodebb-plugin-write-api.git
```

The plugin exposes NodeBB functionality via an API. You can read more about it [here](https://github.com/davidvuong/nodebb-plugin-write-api/blob/master/routes/v1/README.md).

1. After you've correctly installed and activated the `nodebb-plugin-write-api` plugin, create a master token under `/admin/plugins/write-api/`.
1. Turn off the "make user info private" option in your ACP (this is required for `GET /users/uid/:id` requests to work).
1. The last step is to install `pynodebb` from the CheeseShop:

```bash
pip install pynodebb
```

## Example usage

```python
from __future__ import print_function
from pynodebb import Client
Expand All @@ -53,24 +32,7 @@ for topic in topics:

## Documentation

Documentation is available at http://pynodebb.readthedocs.org/en/latest/. If you want to read more about nodebb-plugin-write-api, checkout: https://github.com/davidvuong/nodebb-plugin-write-api/blob/master/routes/v1/README.md.

## Contribution

Please read the [contribution guide](https://github.com/davidvuong/pynodebb/blob/master/CONTRIBUTING.md) before contributing.

1. Clone and install dependencies:

```bash
git clone [email protected]:davidvuong/pynodebb.git

mkvirtualenv pynodebb
cd pynodebb

python setup.py develop
pip install setuptools --upgrade
pip install -r requirements.txt
```
Documentation is available at http://pynodebb.readthedocs.org/en/latest/.

## License

Expand Down

0 comments on commit 431d102

Please sign in to comment.