Skip to main content

A Python wrapper of the Discourse API

Project description

discourse

A Python wrapper of the Discourse API

Version License: GPL v3

This package allows Python developers to write software that makes use of the Discourse API. Functions available in the API are mirrored in this package as closely as possible, translating JSON responses to Python objects. You can find the current documentation for the Discourse API here:

Discourse API Documentation

Installing

pip install discourse

Quick Start

import discourse

client = discourse.Client(
    host='http://127.0.0.1:3000/',
    api_username='discourse1',
    api_key='714552c6148e1617aeab526d0606184b94a80ec048fc09894ff1a72b740c5f19',
)

latest = client.get_latest_topics('default')

for topic in latest:
    print(topic.title)

Full documentation for this package is not yet available. One of the milestones is complete documentation coverage, including currently undocumented portions of the Discourse API. For now, I encourage you to read the source code and use the Discourse API docs, it should be fairly straightforward.

Pull requests welcome!

Project details


Download files

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

Files for discourse, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size discourse-0.1.2-py3-none-any.whl (21.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size discourse-0.1.2.tar.gz (6.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

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