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 Docs, DiscourseAPI
app = Flask("myapp")
session = talisker.requests.get_session()
discourse = Docs(
parser=DocParser(
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 2.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| canonicalwebteam.discourse-2.0.3.tar.gz | 16.3 kB | Without provenance | Details for canonicalwebteam.discourse-2.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| canonicalwebteam.discourse-2.0.3-py3-none-any.whl | Python 3 | none | any | Details for canonicalwebteam.discourse-2.0.3-py3-none-any.whl |
Total release size: 40.4 kB
Release files / canonicalwebteam.discourse-2.0.3.tar.gz
| Download URL | canonicalwebteam.discourse-2.0.3.tar.gz |
|---|---|
| Size | 16.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8a652fa4b81eda4ec8f0c3fa1d09409d586961a8038ab0339553f6fb77014338
|
|
BLAKE2b-256 checksum How to use checksums |
77ff680c5213771f0c3933586364e46df092dffc00b87633d6c97367614f9b19
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.9
|
Release files / canonicalwebteam.discourse-2.0.3-py3-none-any.whl
| Download URL | canonicalwebteam.discourse-2.0.3-py3-none-any.whl |
|---|---|
| Size | 24.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c42a8fd881d832531b8a9a39c41b7e944d11b83bc180e2b78fd95c608e0fa5d7
|
|
BLAKE2b-256 checksum How to use checksums |
460299c7b982186ad3ed702fed5e25633c74021894cb5b1b95f43de57b22d87f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.9
|
Security for canonicalwebteam.discourse 2.0.3
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.