Skip to content

Commit 4ff8ea7

Browse files
add contribution instruction
1 parent 410d9c0 commit 4ff8ea7

File tree

5 files changed

+201
-462
lines changed

5 files changed

+201
-462
lines changed

.github/workflows/publish-marimo.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ jobs:
3333
uv run marimo export html llm/pydantic_ai_examples.py -o build/llm/pydantic_ai_examples.html --sandbox
3434
uv run marimo export html data_science_tools/pandas_api_on_spark.py -o build/data_science_tools/pandas_api_on_spark.html --sandbox
3535
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
3637
- name: Upload Pages Artifact
3738
uses: actions/upload-pages-artifact@v3
3839
with:

contribution.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
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

pyproject.toml

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,9 @@ description = "Add your description here"
55
readme = "README.md"
66
requires-python = ">=3.11"
77
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",
1410
]
1511

1612
[dependency-groups]
17-
dev = [
18-
"pytest>=8.3.5",
19-
]
13+
dev = []

requirements.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)