Skip to main content

canonicalwebteam.discourse

Flask extension to integrate discourse content generated to docs to your website. This project was previously named discourse_docs.

Writing documentation

Documentation for how to write documentation pages in Discourse for consumption by this module and how to configure the website to use the module can be found in the Canonical discourse.

Example Flask template for documentation pages can be found in examples/document.html

Install

Install the project with pip: pip install canonicalwebteam.discourse

You can add the extension on your project as follows, replacing, at least, base_url and index_topic_id with your own settings:

import talisker.requests
from canonicalwebteam.discourse import DiscourseAPI, Tutorials, TutorialParser

app = Flask("myapp")
session = talisker.requests.get_session()

discourse = Tutorials(
    parser=TutorialParser(
        api=DiscourseAPI(
            base_url="https://forum.example.com/", session=session
        ),
        index_topic_id=321,
        url_prefix="/docs",
    ),
    document_template="docs/document.html",
    url_prefix="/docs",
)
discourse.init_app(app)

Once this is added you will need to add the file document.html to your template folder.

Local development

For local development, it's best to test this module with one of our website projects like ubuntu.com. For more information, follow this guide (internal only).

Instructions for Engage pages extension

Because you are viewing a protected topic, you must provide api_key and api_username. You also need an index topic id, which you can get from discourse.ubuntu.com. Your index topic must contain a metadata section. Visit the EngageParser for more information about the structure. You are encouraged to use an blueprint name that does not collide with existent blueprints. The templates must match the ones provided in the parameters indicated.

Here is an example of an implementation:

engage_pages = EngagePages(
    api=DiscourseAPI(
        base_url="https://discourse.ubuntu.com/",
        session=session,
        get_topics_query_id=14,
        api_key=DISCOURSE_API_KEY, # replace with your API key
        api_username=DISCOURSE_API_USERNAME, # replace with correspoding username
    ),
    category_id=51,
    page_type="engage-pages", # one of ["engage-pages", "takeovers"]
    exclude_topics=[] # this is a list of topic ids that we want to exclude from Markdown error checks
)

In your project, you need to create your own views:

app.add_url_rule(
    "/engage", view_func=build_engage_index(engage_pages)
)

app.add_url_rule(
    "/engage/<path>", view_func=single_engage_page(engage_pages)
)
  • Where build_engage_index would be your view for the list of engage pages, which you can get by using the method EngagagePages(args).get_index()
  • While single_engage_page would be your single engage pages view, which you can get using EngagePages(args).get_engage_page(path)

Similarly for takeovers, you just need to pass page_type="takeovers".

  • To get a list of takeovers EngagePages(args).get_index() also.
  • To get a list of active takeovers EngagePages(args).parse_active_takeovers().

Metadata

Release files for canonicalwebteam.discourse 5.0.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 canonicalwebteam.discourse 5.0.0
File Size Uploaded Provenance Actions
canonicalwebteam.discourse-5.0.0.tar.gz 26.7 kB Without provenance Details for canonicalwebteam.discourse-5.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for canonicalwebteam.discourse 5.0.0
File Interpreter ABI Platform Actions
canonicalwebteam.discourse-5.0.0-py3-none-any.whl Python 3 none any Details for canonicalwebteam.discourse-5.0.0-py3-none-any.whl

Total release size: 58.7 kB

Release files / canonicalwebteam.discourse-5.0.0.tar.gz

Download URL canonicalwebteam.discourse-5.0.0.tar.gz
Size 26.7 kB
Tags Source
SHA-256 checksum
How to use checksums
81e9a6e90014fb2da3839581c06bdd88518bdf137b096cdee5109264aca0c90f
BLAKE2b-256 checksum
How to use checksums
7feafe8afff201a7dbb94b9b3d0de7ff352547336f74d820c3d777c5ed5bf6d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.13

Release files / canonicalwebteam.discourse-5.0.0-py3-none-any.whl

Download URL canonicalwebteam.discourse-5.0.0-py3-none-any.whl
Size 32.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e19af1ca2177376621350bfe698909e17d865a57d59ad5dd2462fa1f5ad94844
BLAKE2b-256 checksum
How to use checksums
b38c0bf7ef589d74f62ea03b1d247578c999e7252c2cd4d38871d4a91d349d97
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.13

Security for canonicalwebteam.discourse 5.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.0.0 This release

2 release files No provenance

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