Skip to main content

discodoc - create documents from Discourse content easily

Project description

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

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

discodoc-0.3.0.tar.gz (19.1 kB view hashes)

Uploaded Source

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