Skip to main content
https://img.shields.io/badge/Python-3-green.svg https://img.shields.io/pypi/v/discodoc.svg https://img.shields.io/github/tag/hiveeyes/discodoc.svg

discodoc

About

discodoc - create hard copy-like documents from Discourse content easily.

It aims to make documentation generation effortless.

There might still be dragons.

Synopsis

# Generate PDF document from all posts of given topic.
discodoc https://community.hiveeyes.org/t/anleitung-aufbau-und-installation-des-sensor-kits-grune-platine/2443 --format=pdf

For more information and further examples, please invoke discodoc --help.

Features

All output formats are provided by pandoc fame. These have been tested: pdf, docx, odt, pptx, epub2, epub3, fb2, latex, texinfo, txt, text, html, html5, json, plain, rtf, revealjs, s5.

Installation

Prerequisites

# Debian
apt install texlive-latex-base pandoc

# macOS / Homebrew
brew install pandoc python3-requests
brew cask install basictex

Optional:

brew cask install wkhtmltopdf

For HTML slideshow rendering:

yarn install


wget https://meyerweb.com/eric/tools/s5/v/1.1/s5-11.zip
cp -r ~/Downloads/s5-11/ui node_modules/s5

Setup

pip install discodoc

Caveats

If you are hitting one of the global rate limits and throttling in Discourse indicated like:

{"errors":["You’ve performed this action too many times, please try again later."]}

You might want to authenticate using an appropriate API key like:

export DISCOURSE_API_KEY=5c58bf5e4027622543f5179938182099c8b97188d00a9dc9f184cd3ca66db5ea

Credits

You know how you are. Thanks!

Other programs

Metadata

Release files for discodoc 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for discodoc 0.3.0
File Size Uploaded
discodoc-0.3.0.tar.gz 19.1 kB Details

Release files / discodoc-0.3.0.tar.gz

Download URL discodoc-0.3.0.tar.gz
Size 19.1 kB
Tags Source
SHA-256 checksum
How to use checksums
66cd37b67544f8cfedfc0c96c662476d6e6e208782d31ff7e2bade5aefac04e5
BLAKE2b-256 checksum
How to use checksums
86aa5e74fe8666e287f1d282a12e343b9d22e4caa38ed44c8bcf41407b4a047a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.4

Release history Release notifications | RSS feed

This release

0.3.0 This release

1 release file

0.2.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page