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.

Source Distribution

discourse-0.1.2.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

discourse-0.1.2-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

Details for the file discourse-0.1.2.tar.gz.

File metadata

  • Download URL: discourse-0.1.2.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.0 CPython/3.7.4

File hashes

Hashes for discourse-0.1.2.tar.gz
Algorithm Hash digest
SHA256 706b8194119168d3a4c193023e8eadfb348b08bf1e8b86468f229c9fa4278100
MD5 c762e202c6f00f26f941816848aeb5b3
BLAKE2b-256 712e634a9d0e56115785be4a109bb6f56eb7f9ff38400bd39b0e54e023cb5113

See more details on using hashes here.

File details

Details for the file discourse-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: discourse-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 21.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.0 CPython/3.7.4

File hashes

Hashes for discourse-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fe7c5c002f89f283ca41237b62bdaba0a3be45fa78c0c68dc446b2eb0eaa0d2a
MD5 2fececfeec928f4dfc423af74f30991e
BLAKE2b-256 a23d725825efa727479ef54aa3a018394589b63b631ee2636a59fa6ae885d02d

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