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.

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.

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_path = "/engage"
engage_docs = EngagePages(
    parser=EngageParser(
        api=DiscourseAPI(
            base_url="https://discourse.ubuntu.com/",
            session=session,
            api_key="secretkey", # API KEY used in the tests
            api_username="canonical",
        ),
        index_topic_id=17229,
        url_prefix=engage_path,
    ),
    document_template="/engage/base.html",
    url_prefix=engage_path,
    blueprint_name="engage-pages",
)

Additionally, if you need a list of all engage pages, you would construct a view this way:

app.add_url_rule(
    engage_path, view_func=build_engage_index(engage_docs)
)

Where build_engage_index would be your view.

Metadata

Release files for canonicalwebteam.discourse 4.0.7

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 4.0.7
File Size Uploaded Provenance Actions
canonicalwebteam.discourse-4.0.7.tar.gz 24.0 kB Without provenance Details for canonicalwebteam.discourse-4.0.7.tar.gz

Built distribution (wheel)

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

Total release size: 54.4 kB

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

Download URL canonicalwebteam.discourse-4.0.7.tar.gz
Size 24.0 kB
Tags Source
SHA-256 checksum
How to use checksums
6d82d86d01d64dfb4e978e7e4977bf39dfcc1960f639288a72c54ecef84a528d
BLAKE2b-256 checksum
How to use checksums
b7f408b78ea021df869be3a1969aba95bbcce3663973d34e639b41c4242aa9ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

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

Download URL canonicalwebteam.discourse-4.0.7-py3-none-any.whl
Size 30.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
115788701eaedddf34e642f0c41e94e9e6476faa8578a58ea34fc5009a7f0e1b
BLAKE2b-256 checksum
How to use checksums
87fdd8ec0ea391733355bc1c984c5faa24e275cacee3db3824f8ab8d88feac08
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Security for canonicalwebteam.discourse 4.0.7

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

4.0.7 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