Skip to content

Commit 572dbdb

Browse files
gordonwoodhullgordonwoodhull
committed
Initialising gh-pages branch
0 parents  commit 572dbdb

31 files changed

+10514
-0
lines changed

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# SCM syntax highlighting & preventing 3-way merges
2+
pixi.lock merge=binary linguist-language=YAML linguist-generated=true

‎.github/workflows/ci.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: CI
2+
3+
jobs:
4+
lint:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v4
8+
9+
- uses: prefix-dev/setup-pixi@v0.8.8
10+
with:
11+
pixi-version: v0.40.2
12+
13+
- name: Lint
14+
run: pixi run lint

‎.github/workflows/deploy.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: documentation
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
build-and-deploy:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: checkout
11+
uses: actions/checkout@v4
12+
13+
- uses: prefix-dev/setup-pixi@v0.8.8
14+
with:
15+
pixi-version: v0.40.2
16+
17+
- name: Render
18+
run: pixi run ci
19+
20+
- name: deploy
21+
uses: JamesIves/github-pages-deploy-action@releases/v4
22+
with:
23+
branch: gh-pages
24+
folder: _site

‎.gitignore‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
*_files/
2+
script.py
3+
script.*
4+
*.html
5+
!example-pyscript-header.html
6+
.quarto/
7+
_output/
8+
_site/
9+
10+
__pycache__
11+
12+
/.quarto/
13+
14+
*.aux
15+
*.log
16+
*.pdf
17+
*.tex
18+
19+
20+
*.AppImage
21+
result
22+
23+
# pixi environments
24+
.pixi
25+
*.egg-info
26+
27+
**/*.quarto_ipynb

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# marimo + quarto = :palm_tree: :heart:
2+
3+
## marimo
4+
5+
marimo is a next generation python notebook that is embeddable anywhere.
6+
As such, it is a great fit for quarto, which has reactive and robust a publishing system.
7+
This repo is a quarto filter that lets you use marimo in your quarto documents; just follow the setup below.
8+
9+
### Quick Start
10+
11+
**1.** Tool Installation
12+
13+
- Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
14+
- Install [Quarto](https://quarto.org/docs/get-started/) (if you have brew: `brew install quarto`)
15+
16+
**2.** Create a project
17+
18+
```bash
19+
quarto create project
20+
```
21+
22+
**3.** Add `quarto-marimo` to your project
23+
24+
```bash
25+
quarto add marimo-team/quarto-marimo
26+
```
27+
28+
**4.** Edit your `index.qmd`
29+
30+
````yaml
31+
---
32+
filters:
33+
- marimo-team/marimo
34+
---
35+
36+
# Just another Quarto project
37+
38+
```python {.marimo}
39+
#| echo: true
40+
import marimo as mo
41+
slider = mo.ui.slider(1, 10, 1, label="Look, a slider!")
42+
slider
43+
```
44+
45+
## More things
46+
47+
And we can respond!
48+
49+
```python {.marimo}
50+
# No echo here means we do not show the code
51+
mo.md("NaN" * slider.value + " Batman!")
52+
```
53+
````
54+
55+
**5.** Run!
56+
57+
```bash
58+
quarto preview
59+
# uvx --with marimo --from quarto-cli quarto preview
60+
```
61+
62+
### Features
63+
64+
This plugin uses [`marimo
65+
islands`](https://docs.marimo.io/guides/exporting/?h=islands#islands-in-action)
66+
:palm_tree: which allows marimo content to be embedded in between other
67+
content. In addition to base marimo support, some [Quarto execution
68+
options](https://quarto.org/docs/computations/execution-options.html) are also
69+
supported:
70+
71+
| Option | Default | Description |
72+
|--------|---------|-------------|
73+
eval | True | Whether this code should run
74+
echo | False | Whether to show the code in the output
75+
output | True | Whether to show the output
76+
warning | True | Whether to show warnings
77+
error | True | Whether to show errors
78+
include | True | Whether to consider the block as part of the document
79+
editor | False | Whether to show the editor (only for marimo)
80+
81+
:bulb: **Note**: You can open `.md` and `.qmd` files directly in marimo
82+
like a normal notebook. Read more about it in the
83+
[tutorial](https://github.com/marimo-team/marimo/blob/main/marimo/_tutorials/markdown_format.md)
84+
85+
:notebook: [**Check out the marimo mkdocs
86+
extension**](https://github.com/marimo-team/mkdocs-marimo)
87+
88+
### Environment
89+
90+
By default, marimo will use `uv` to create a new virtual environment.
91+
You can specify dependencies by [following our docs](https://docs.marimo.io/guides/package_reproducibility#markdown-file-support)
92+
and setting the yaml `pyproject` value in your notebook.
93+
94+
To disable sandboxed behavior, set `external-env: true` in your notebook yaml; this requires an active virtual environment with marimo installed.
95+
96+
> [!NOTE]
97+
> You can add `pyproject` or `enternal-env` to your `_quarto.yml` file for global behavior
98+
99+
Note, that local files are not bound to be accessible in WASM runtimes- and on
100+
web load, dependencies are installed via [`micropip`](https://github.com/pyodide/micropip).
101+
As such, this is mainly advised for PDF rendering, or other output formats that do not support
102+
Javascript.
103+
104+
---
105+
106+
## Development
107+
108+
To build the TypeScript engine extension:
109+
110+
```bash
111+
quarto call build-ts-extension
112+
```
113+
114+
This bundles `src/marimo-engine.ts` into `_extensions/marimo/marimo-engine.js`.
115+
116+
---
117+
118+
Credits: [holoviz-quarto](https://github.com/awesome-panel/holoviz-quarto) for ideas on layout

‎_extensions/marimo/_extension.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
title: Quarto Marimo Extension
2+
version: 0.5.0
3+
quarto-required: ">=1.3.0"
4+
contributes:
5+
engines:
6+
- path: marimo-engine.js

0 commit comments

Comments
 (0)