# 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](https://discourse.canonical.com/t/creating-discourse-based-documentation-pages/159).
Example Flask template for documentation pages can be found in [`examples`](/examples/) folder. Please refer to the [README](/examples/README.md) in that folder for more information.
## 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:
```python
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](https://github.com/canonical-web-and-design/ubuntu.com/). For more information, follow [this guide (internal only)](https://discourse.canonical.com/t/how-to-run-our-python-modules-for-local-development/308).
### Running tests, linting and formatting
Tests can be run with [Tox](https://tox.wiki/en/latest/):
``` bash
pip3 install tox # Install tox
tox # Run tests
tox -e lint # Check the format of Python code
tox -e format # Reformat the Python code
```
## 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:
```python
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
additional_metadata_validation=[] # list of additional keys in the metadata table that you want to validate existence for e.g. language
)
```
In your project, you need to create your own views:
```python
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()`.
## Pagination
- `get_index` provides two additional arguments `limit` and `offset`, to provide pagination functionality. They default to 50 and 0 respectively.
- If you want to get all engage pages, which in the case of some sites like jp.ubuntu.com there are not that many, you can pass `limit=-1`
- Use `MaxLimitError` in the `exceptions.py` to handle excessive limit. By default, it will raise an error when it surpasses 500
## Instructions for Category class usage
This works similar to the other class but exposes some specific functions that can be run on the index topic and the category as a whole.
It exposes a some APIs that can then be called from within a view func for processing.
Here is an example of the implementation:
```
security_vulnerabilities = Category(
parser=CategoryParser(
api=discourse_api,
index_topic_id=53193,
url_prefix="/security/vulnerabilities",
),
category_id=308,
)
```
The `security_vulnerabilities` object exposes the following APIs:
- get_topic(path): Fetches a single topic using its URL (path).
- get_category_index_metadata(data_name): Retrieves metadata for the category index. You can optionally specify a data_name to get data for just one table.
- get_topics_in_category(): Retrieves all topics within the currently active category.
- get_category_events(limit=100, offset=0): Retrieves all future events in a category. Requires the Discourse Events plugin to be installed on the instance.
## Instructions for Events class usage
This class provides functionality for managing and parsing events from Discourse topics, particularly useful for event-driven websites that need to display upcoming events, featured events, and event categories. It relies on the plugin, [Discourse Calendar](https://meta.discourse.org/t/discourse-calendar-and-event/97376).
It exposes APIs that can be called from within a view function for processing event data.
Here is an example of the implementation:
```python
events = Events(
parser=EventsParser(
api=discourse_api,
index_topic_id=12345,
url_prefix="/events",
),
category_id=25,
)
```
The `events` object exposes the following APIs:
- get_events(): Fetches all future events from the target Discourse instance.
- get_featured_events(target_tag="featured-event"): Retrieves all events with a given tagrte tag, defaults to "featured-event"
Raw data
{
"_id": null,
"home_page": "https://github.com/canonical/canonicalwebteam.discourse",
"name": "canonicalwebteam.discourse",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Canonical webteam",
"author_email": "webteam@canonical.com",
"download_url": "https://files.pythonhosted.org/packages/28/ed/8dab6977e8904bb56c9958a1bc7139633918fbf0779921cfd0cdeea410f6/canonicalwebteam_discourse-7.0.0.tar.gz",
"platform": null,
"description": "# canonicalwebteam.discourse\n\nFlask extension to integrate discourse content generated to docs to your website. This project was previously named `discourse_docs`.\n\n## Writing documentation\n\nDocumentation 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](https://discourse.canonical.com/t/creating-discourse-based-documentation-pages/159).\n\nExample Flask template for documentation pages can be found in [`examples`](/examples/) folder. Please refer to the [README](/examples/README.md) in that folder for more information.\n\n## Install\n\nInstall the project with pip: `pip install canonicalwebteam.discourse`\n\nYou can add the extension on your project as follows, replacing, at least, `base_url` and `index_topic_id` with your own settings:\n\n```python\nimport talisker.requests\nfrom canonicalwebteam.discourse import DiscourseAPI, Tutorials, TutorialParser\n\napp = Flask(\"myapp\")\nsession = talisker.requests.get_session()\n\ndiscourse = Tutorials(\n parser=TutorialParser(\n api=DiscourseAPI(\n base_url=\"https://forum.example.com/\", session=session\n ),\n index_topic_id=321,\n url_prefix=\"/docs\",\n ),\n document_template=\"docs/document.html\",\n url_prefix=\"/docs\",\n)\ndiscourse.init_app(app)\n```\n\nOnce this is added you will need to add the file `document.html` to your template folder.\n\n## Local development\n\nFor local development, it's best to test this module with one of our website projects like [ubuntu.com](https://github.com/canonical-web-and-design/ubuntu.com/). For more information, follow [this guide (internal only)](https://discourse.canonical.com/t/how-to-run-our-python-modules-for-local-development/308).\n\n### Running tests, linting and formatting\n\nTests can be run with [Tox](https://tox.wiki/en/latest/):\n\n``` bash\npip3 install tox # Install tox\ntox # Run tests\ntox -e lint # Check the format of Python code\ntox -e format # Reformat the Python code\n```\n\n## Instructions for Engage pages extension\n\nBecause 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.\n\nHere is an example of an implementation:\n\n```python\nengage_pages = EngagePages(\n api=DiscourseAPI(\n base_url=\"https://discourse.ubuntu.com/\",\n session=session,\n get_topics_query_id=14,\n api_key=DISCOURSE_API_KEY, # replace with your API key\n api_username=DISCOURSE_API_USERNAME, # replace with correspoding username\n ),\n category_id=51,\n page_type=\"engage-pages\", # one of [\"engage-pages\", \"takeovers\"]\n exclude_topics=[] # this is a list of topic ids that we want to exclude from Markdown error checks\n additional_metadata_validation=[] # list of additional keys in the metadata table that you want to validate existence for e.g. language\n)\n```\n\nIn your project, you need to create your own views:\n\n```python\napp.add_url_rule(\n \"/engage\", view_func=build_engage_index(engage_pages)\n)\n\napp.add_url_rule(\n \"/engage/<path>\", view_func=single_engage_page(engage_pages)\n)\n```\n\n- 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()`\n- While `single_engage_page` would be your single engage pages view, which you can get using `EngagePages(args).get_engage_page(path)`\n\nSimilarly for takeovers, you just need to pass `page_type=\"takeovers\"`.\n\n- To get a list of takeovers `EngagePages(args).get_index()` also.\n- To get a list of active takeovers `EngagePages(args).parse_active_takeovers()`.\n\n## Pagination\n- `get_index` provides two additional arguments `limit` and `offset`, to provide pagination functionality. They default to 50 and 0 respectively.\n- If you want to get all engage pages, which in the case of some sites like jp.ubuntu.com there are not that many, you can pass `limit=-1`\n- Use `MaxLimitError` in the `exceptions.py` to handle excessive limit. By default, it will raise an error when it surpasses 500\n\n\n## Instructions for Category class usage\n\nThis works similar to the other class but exposes some specific functions that can be run on the index topic and the category as a whole.\n\nIt exposes a some APIs that can then be called from within a view func for processing.\n\nHere is an example of the implementation:\n\n```\nsecurity_vulnerabilities = Category(\n parser=CategoryParser(\n api=discourse_api,\n index_topic_id=53193,\n url_prefix=\"/security/vulnerabilities\",\n ),\n category_id=308,\n)\n```\n\nThe `security_vulnerabilities` object exposes the following APIs:\n\n- get_topic(path): Fetches a single topic using its URL (path).\n- get_category_index_metadata(data_name): Retrieves metadata for the category index. You can optionally specify a data_name to get data for just one table.\n- get_topics_in_category(): Retrieves all topics within the currently active category.\n- get_category_events(limit=100, offset=0): Retrieves all future events in a category. Requires the Discourse Events plugin to be installed on the instance.\n\n## Instructions for Events class usage\n\nThis class provides functionality for managing and parsing events from Discourse topics, particularly useful for event-driven websites that need to display upcoming events, featured events, and event categories. It relies on the plugin, [Discourse Calendar](https://meta.discourse.org/t/discourse-calendar-and-event/97376).\n\nIt exposes APIs that can be called from within a view function for processing event data.\n\nHere is an example of the implementation:\n\n```python\nevents = Events(\n parser=EventsParser(\n api=discourse_api,\n index_topic_id=12345,\n url_prefix=\"/events\",\n ),\n category_id=25,\n)\n```\n\nThe `events` object exposes the following APIs:\n\n- get_events(): Fetches all future events from the target Discourse instance.\n- get_featured_events(target_tag=\"featured-event\"): Retrieves all events with a given tagrte tag, defaults to \"featured-event\"\n",
"bugtrack_url": null,
"license": null,
"summary": "Flask extension to integrate discourse content generated to docs to your website.",
"version": "7.0.0",
"project_urls": {
"Homepage": "https://github.com/canonical/canonicalwebteam.discourse"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aefe4bcb4eefb5b343998ec5b1af45e08747ca0314f39e911e2a777bec1ba139",
"md5": "57777f112f19a75e5e16650051696837",
"sha256": "87f0a951309f3552a4c96a9f1ad6c975babee6d3eaf75b100b5e8afb4267b428"
},
"downloads": -1,
"filename": "canonicalwebteam_discourse-7.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57777f112f19a75e5e16650051696837",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 43372,
"upload_time": "2025-08-01T07:35:20",
"upload_time_iso_8601": "2025-08-01T07:35:20.762563Z",
"url": "https://files.pythonhosted.org/packages/ae/fe/4bcb4eefb5b343998ec5b1af45e08747ca0314f39e911e2a777bec1ba139/canonicalwebteam_discourse-7.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "28ed8dab6977e8904bb56c9958a1bc7139633918fbf0779921cfd0cdeea410f6",
"md5": "35b9f512a9a8536d1099bfac3a20391f",
"sha256": "2c1245144af78863c2ec34dbb7efc23ecf2f63d91a79393cd6f84eed229ca917"
},
"downloads": -1,
"filename": "canonicalwebteam_discourse-7.0.0.tar.gz",
"has_sig": false,
"md5_digest": "35b9f512a9a8536d1099bfac3a20391f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38237,
"upload_time": "2025-08-01T07:35:21",
"upload_time_iso_8601": "2025-08-01T07:35:21.682278Z",
"url": "https://files.pythonhosted.org/packages/28/ed/8dab6977e8904bb56c9958a1bc7139633918fbf0779921cfd0cdeea410f6/canonicalwebteam_discourse-7.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-01 07:35:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "canonical",
"github_project": "canonicalwebteam.discourse",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "canonicalwebteam.discourse"
}
JSON
