File tree Expand file tree Collapse file tree 5 files changed +201
-462
lines changed Expand file tree Collapse file tree 5 files changed +201
-462
lines changed Original file line number Diff line number Diff line change 33
33
uv run marimo export html llm/pydantic_ai_examples.py -o build/llm/pydantic_ai_examples.html --sandbox
34
34
uv run marimo export html data_science_tools/pandas_api_on_spark.py -o build/data_science_tools/pandas_api_on_spark.html --sandbox
35
35
uv run marimo export html data_science_tools/pyspark_parametrize.py -o build/data_science_tools/pyspark_parametrize.html --sandbox
36
+ uv run marimo export html data_science_tools/narwhals.py -o build/data_science_tools/narwhals.html --sandbox
36
37
- name : Upload Pages Artifact
37
38
uses : actions/upload-pages-artifact@v3
38
39
with :
Original file line number Diff line number Diff line change
1
+ # Contribution Guidelines
2
+
3
+ ## Environment Setup
4
+
5
+ ### Install uv
6
+
7
+ [ uv] ( https://github.com/astral.sh/uv ) is a fast Python package installer and resolver.
8
+
9
+ ``` bash
10
+ # Install uv
11
+ curl -LsSf https://astral.sh/uv/install.sh | sh
12
+
13
+ # Verify installation
14
+ uv --version
15
+ ```
16
+
17
+ ### Install Dependencies
18
+
19
+ ``` bash
20
+ # Install dependencies from pyproject.toml
21
+ uv sync
22
+ ```
23
+
24
+ ### Install Pre-commit Hooks
25
+
26
+ We use pre-commit to ensure code quality and consistency.
27
+
28
+ ``` bash
29
+ # Install pre-commit hooks
30
+ uv run pre-commit install
31
+ ```
32
+
33
+ ## Working with Marimo Notebooks
34
+
35
+ ### Creating a New Notebook
36
+
37
+ Create a new notebook using marimo:
38
+
39
+ ``` bash
40
+ uv run marimo edit notebook.py --sandbox
41
+ ```
42
+
43
+ ### Publishing Notebooks
44
+
45
+ Add the following workflow to ` .github/workflows/publish-marimo.yml ` :
46
+
47
+ ``` yaml
48
+ ...
49
+ jobs :
50
+ publish :
51
+ runs-on : ubuntu-latest
52
+ steps :
53
+ ...
54
+ - name : Export notebook
55
+ run : |
56
+ uv run marimo export html notebook.py -o build/notebook.html --sandbox
57
+ ...
58
+ ```
59
+
60
+ ## Pull Request Process
61
+
62
+ 1 . Fork the repository
63
+ 2 . Create a new branch for your feature
64
+ 3 . Make your changes
65
+ 4 . Submit a pull request with a clear description of changes
Original file line number Diff line number Diff line change @@ -5,15 +5,9 @@ description = "Add your description here"
5
5
readme = " README.md"
6
6
requires-python = " >=3.11"
7
7
dependencies = [
8
- " loguru>=0.7.3" ,
9
- " marimo==0.13.6" ,
10
- " narwhals==1.36.0" ,
11
- " nbformat>=5.10.4" ,
12
- " pandas>=2.2.3" ,
13
- " pyspark[sql]>=3.5.5" ,
8
+ " marimo>=0.13.7" ,
9
+ " pre-commit>=4.2.0" ,
14
10
]
15
11
16
12
[dependency-groups ]
17
- dev = [
18
- " pytest>=8.3.5" ,
19
- ]
13
+ dev = []
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments