├── .pre-commit-config.yaml ├── LICENSE ├── README.md ├── pyproject.toml ├── requirements.txt └── streamlit_app.py /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/psf/black 3 | rev: 22.3.0 4 | hooks: 5 | - id: black 6 | language_version: python3.8 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Streamlit + Notion test app 2 | 3 | Write Streamlit apps using Notion! 4 | 5 | ☠️ **IMPORTANT:** This is just a little prototype I made to play with some ideas. Not meant for production! 6 | 7 | * Example app: https://notionlit.streamlitapp.com/ 8 | * Notion page with source code: https://www.notion.so/streamlit/NotionLit-d500932b258b43298b509eb6dd3db230 9 | 10 | 👉 **Try editing the Notion page, then going to the app and pressing `R` to refresh!** 11 | 12 | # Forking instructions 13 | 14 | 1. Fork this app into your own repo 15 | (or just copy `streamlit_app.py`. It's fully self-contained!) 16 | 17 | 1. Create [a new integration in Notion](https://www.notion.so/my-integrations). 18 | When you're done, grab the secret token as you'll need it later. 19 | 20 | 1. Create a page in Notion, then: 21 | 1. Share it with your integration 22 | 1. Grab the page URL as you'llneed it later. 23 | 24 | 1. Deploy your app with [share.streamlit.io](https://share.streamlit.io/). 25 | 26 | 1. [Set up your app's secrets](https://docs.streamlit.io/streamlit-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management), 27 | adding in the secret token and page URL from the steps above. 28 | ``` 29 | [notion] 30 | token = "YOUR_NOTION_SECRET" 31 | page_url = "YOUR_NOTION_PAGE_URL" 32 | ``` 33 | 34 | **🥳 Done!** 35 | 36 | Now any time you edit your Notion page, go into your Streamlit app and press `R` to rerun it 37 | (thereby fetching the latest content from Notion). 38 | 39 | 40 | # But wait, there's more! 41 | 42 | If you add a code block in Notion **and mark it as a Python block,** it will actually get executed 43 | when you load your app! 44 | 45 | So try adding a Python block with this into your Notion page: 46 | 47 | ``` 48 | import streamlit as st 49 | import numpy as np 50 | 51 | num_rows = st.slider("Number of rows", 1, 500, 100) 52 | data = np.random.randn(num_rows, 5) 53 | 54 | st.write(data) 55 | st.line_chart(data) 56 | ``` 57 | 58 | (If you need other Python packages, add them to your `requirements.txt`) 59 | 60 | One more thing: let's say you want to execute Python code, but don't want to 61 | pollute your Notion page with too much ugly code. There's a hack for that. 62 | Just put the code inside an expander **without a title or with a title equal to "Code".** 63 | 64 | 65 | # What's supported 66 | 67 | * Headers 68 | * Paragraphs (with bold/italic/strikethrough/links) 69 | * Images 70 | * Code blocks 71 | * Expanders 72 | * @user_mentions 73 | * @date_mentions 74 | 75 | And that's all ☹️ 76 | 77 | Again, this is just a proof-of-concept / prototype. So I didn't implement a bunch of other stuff, 78 | like underline, @page_mentions, columns, etc. 79 | 80 | Also note that not everything in Streamlit is supported either. I 81 | don't have an exhaustive list but, for example, 82 | [magic](https://docs.streamlit.io/library/api-reference/write-magic/magic) doesn't work. 83 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.black] 2 | line-length = 88 3 | target-version = ['py36', 'py37', 'py38'] 4 | include = '\.pyi?$' -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | streamlit 2 | notion-client==1.0.* 3 | htbuilder 4 | black 5 | pre-commit -------------------------------------------------------------------------------- /streamlit_app.py: -------------------------------------------------------------------------------- 1 | from typing import Dict 2 | 3 | import streamlit as st 4 | from htbuilder import a, div, styles 5 | from htbuilder.funcs import var 6 | from htbuilder.units import rem 7 | from notion_client import Client 8 | from notion_client.helpers import get_id 9 | 10 | notion = Client(auth=st.secrets.notion.token) 11 | 12 | 13 | def get_page_blocks(): 14 | blocks = notion.blocks.children.list(get_id(st.secrets.notion.page_url)) 15 | return blocks 16 | 17 | 18 | def get_pure_text_from_text_dict(text): 19 | return "".join(token["text"]["content"] for token in text) 20 | 21 | 22 | def get_markdown_from_text_dict(text): 23 | out = [] 24 | for token in text: 25 | markdown = None 26 | 27 | if token["type"] == "text": 28 | markdown = token["text"]["content"] 29 | annots = token["annotations"] 30 | if token["text"]["link"]: 31 | markdown = f'[{markdown}]({token["text"]["link"]["url"]})' 32 | if annots["bold"]: 33 | markdown = f"**{markdown}**" 34 | if annots["italic"]: 35 | markdown = f"_{markdown}_" 36 | if annots["strikethrough"]: 37 | markdown = f"~~{markdown}~~" 38 | 39 | elif token["type"] == "mention": 40 | mention = token["mention"] 41 | 42 | if mention["type"] == "date": 43 | date = mention["date"] 44 | if "end" in date and date["end"] is not None: 45 | markdown = f"{date['start']}–{date['end']}" 46 | else: 47 | markdown = date["start"] 48 | elif mention["type"] == "user": 49 | user = mention["user"] 50 | markdown = f"@{user['name']}" 51 | 52 | if markdown: 53 | out.append(markdown) 54 | 55 | return "".join(out) 56 | 57 | 58 | def handle_block(block: Dict): 59 | if block["type"] == "heading_1": 60 | md = get_markdown_from_text_dict(block["heading_1"]["rich_text"]) 61 | st.write(f"# {md}") 62 | 63 | elif block["type"] == "heading_2": 64 | md = get_markdown_from_text_dict(block["heading_2"]["rich_text"]) 65 | st.write(f"## {md}") 66 | 67 | elif block["type"] == "heading_3": 68 | md = get_markdown_from_text_dict(block["heading_3"]["rich_text"]) 69 | st.write(f"### {md}") 70 | 71 | elif block["type"] == "paragraph": 72 | md = get_markdown_from_text_dict(block["paragraph"]["rich_text"]) 73 | st.write(md) 74 | 75 | elif block["type"] == "image": 76 | md = get_markdown_from_text_dict(block["image"]["caption"]) 77 | st.image(block["image"]["file"]["url"], md) 78 | 79 | elif block["type"] == "code": 80 | txt = get_pure_text_from_text_dict(block["code"]["rich_text"]) 81 | 82 | # Treat Python codeblocks differently 83 | if block["code"]["language"] == "python": 84 | exec(txt, globals()) 85 | else: 86 | st.code(txt, language=block["code"]["language"]) 87 | 88 | elif block["type"] == "toggle": 89 | md = get_markdown_from_text_dict(block["toggle"]["rich_text"]).strip() 90 | content_blocks = notion.blocks.children.list(block["id"]) 91 | 92 | if ( 93 | (len(md) == 0 or md.lower() == "code") # Title is empty or equal to "Code" 94 | and content_blocks 95 | and len(content_blocks["results"]) 96 | == 1 # Only execute if there's a single code block 97 | ): 98 | child_block = content_blocks["results"][0] 99 | 100 | if ( 101 | child_block["type"] == "code" 102 | and child_block["code"]["language"] == "python" 103 | ): 104 | txt = get_pure_text_from_text_dict(child_block["code"]["rich_text"]) 105 | exec(txt, globals()) 106 | else: 107 | with st.expander(md): 108 | draw_blocks(content_blocks) 109 | 110 | elif block["type"] == "divider": 111 | st.write("---") 112 | 113 | elif block["type"] == "bulleted_list_item": 114 | md = get_markdown_from_text_dict(block["bulleted_list_item"]["rich_text"]) 115 | st.write(f"* {md}") 116 | 117 | elif block["type"] == "numbered_list_item": 118 | md = get_markdown_from_text_dict(block["numbered_list_item"]["rich_text"]) 119 | st.write(f"1. {md}") 120 | 121 | 122 | def draw_blocks(blocks): 123 | for block in blocks["results"]: 124 | try: 125 | handle_block(block) 126 | except Exception as e: 127 | st.exception(e) 128 | st.expander("Show problematic block").write(block) 129 | 130 | 131 | st.write( 132 | str( 133 | div(style=styles(position="fixed", top=rem(1), left=rem(1), z_index=2147483647,))( 134 | a( 135 | href=st.secrets.notion.page_url, 136 | target="_blank", 137 | style=styles( 138 | color=var("--text-color"), 139 | text_decoration="none", 140 | ), 141 | )("✏️ Edit") 142 | ) 143 | ), 144 | unsafe_allow_html=True, 145 | ) 146 | 147 | 148 | blocks = get_page_blocks() 149 | 150 | draw_blocks(blocks) 151 | 152 | # with st.expander("Notionlit debug info"): 153 | # blocks 154 | --------------------------------------------------------------------------------