Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/okld/streamlit-discourse
A streamlit component to embed Discourse topics in your applications.
https://github.com/okld/streamlit-discourse
demo discourse python streamlit streamlit-component streamlit-discourse
Last synced: about 1 month ago
JSON representation
A streamlit component to embed Discourse topics in your applications.
- Host: GitHub
- URL: https://github.com/okld/streamlit-discourse
- Owner: okld
- License: mit
- Created: 2020-12-16T22:14:54.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-24T23:31:23.000Z (over 3 years ago)
- Last Synced: 2024-09-30T09:02:54.133Z (about 2 months ago)
- Topics: demo, discourse, python, streamlit, streamlit-component, streamlit-discourse
- Language: TypeScript
- Homepage: https://share.streamlit.io/okld/streamlit-gallery/main?p=discourse
- Size: 130 KB
- Stars: 13
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 💬 Streamlit Discourse
[![GitHub][github_badge]][github_link] [![PyPI][pypi_badge]][pypi_link]
## Installation
```sh
pip install streamlit-discourse
```
## Getting started
```python
from streamlit_discourse import st_discourse
# https://discuss.streamlit.io/t/discourse-component/8061
discourse_url = "discuss.streamlit.io"
topic_id = 8061
st_discourse(discourse_url, topic_id)
```
## Tutorial
### Embed Streamlit topics into your Streamlit Sharing apps
Let's say you made a topic on this forum showcasing one of your apps.
Now you want to integrate comments from your topic directly in it.
1. The first step is to get your **Topic ID**.
You can find it in the URL of your topic.
For instance with this URL: https://discuss.streamlit.io/t/discourse-integration/8061, the Topic ID is 8061, located at the end.
2. Now in your app, you just have to call `st_discourse("discuss.streamlit.io", 8061)`
> :warning: If your app is **not** run from share.streamlit.io, you won't be able to embed comments from discuss.streamlit.io.
> The same thing applies when you run your app locally, you'll get an `Embedding error`.
>
> If your app is not hosted on Streamlit Sharing, please refer to the two next parts below.
### Embed posts from another Discourse into your Streamlit apps
With this component, you can embed comments from other Discourse websites as well.
However, those other Discourse must be configured to allow embedding for your Streamlit app domain.
For example, if you have a discourse hosted on mydiscourse.example.com, and your streamlit app on myapp.herokuapp.com, you must allow the host myapp.herokuapp.com in your discourse configuration.
For more information, please follow steps 1 to 3 described [here](https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963#configuring-discourse-for-embedding-simple-setup).
### Another way to embed comments into your Streamlit apps
Not everyone has its own Discourse, or has admin rights to change embedding settings.
If you're just looking for an easy way to embed comments into your apps **not** hosted on Streamlit Sharing, a great alternative would be to use [Disqus](https://disqus.com/).
You can easily embed comments using [this component](https://share.streamlit.io/okld/streamlit-gallery/main?p=disqus) ([github](https://github.com/okld/streamlit-disqus)).
## Demo
[![Open in Streamlit][share_badge]][share_link]
[![Preview][share_img]][share_link]
[share_badge]: https://static.streamlit.io/badges/streamlit_badge_black_white.svg
[share_link]: https://share.streamlit.io/okld/streamlit-gallery/main?p=discourse
[share_img]: https://raw.githubusercontent.com/okld/streamlit-discourse/main/preview.png
[github_badge]: https://badgen.net/badge/icon/GitHub?icon=github&color=black&label
[github_link]: https://github.com/okld/streamlit-discourse
[pypi_badge]: https://badgen.net/pypi/v/streamlit-discourse?icon=pypi&color=black&label
[pypi_link]: https://pypi.org/project/streamlit-discourse