Spaces:
Running
Running
Akshay Agrawal
commited on
Commit
Β·
8d8bf5a
1
Parent(s):
d66a745
READMEs, templates, typos CI
Browse files- .github/ISSUE_TEMPLATE/example_request.yaml +17 -0
- .github/PULL_REQUEST_TEMPLATE.md +13 -0
- .github/workflows/typos.yaml +16 -0
- README.md +0 -0
- python/README.md +19 -2
.github/ISSUE_TEMPLATE/example_request.yaml
ADDED
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# yaml-language-server: $schema=https://raw.githubusercontent.com/SchemaStore/schemastore/refs/heads/master/src/schemas/json/github-issue-forms.json
|
2 |
+
name: 'π Course or notebook proposal'
|
3 |
+
description: Request a course or notebook
|
4 |
+
type: Example
|
5 |
+
body:
|
6 |
+
- type: markdown
|
7 |
+
attributes:
|
8 |
+
value: |
|
9 |
+
Let us know what you'd like to see added!
|
10 |
+
- type: textarea
|
11 |
+
id: example-description
|
12 |
+
attributes:
|
13 |
+
label: Description
|
14 |
+
description: 'Description of the notebook or course to add. Please make the reason and usecases as detailed as possible. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
|
15 |
+
placeholder: I would like a notebook or course on ...
|
16 |
+
validations:
|
17 |
+
required: true
|
.github/PULL_REQUEST_TEMPLATE.md
ADDED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
## π Summary
|
2 |
+
|
3 |
+
<!--
|
4 |
+
Provide a concise summary of what this pull request is addressing.
|
5 |
+
|
6 |
+
Link to the issue in which this notebook or course was proposed.
|
7 |
+
-->
|
8 |
+
|
9 |
+
## π Checklist
|
10 |
+
|
11 |
+
- [ ] I have included package dependencies in the notebook file [using `--sandbox`](https://docs.marimo.io/guides/package_reproducibility/)
|
12 |
+
- [ ] If adding a course, include a `README.md`
|
13 |
+
- [ ] Keep language direct and simple.
|
.github/workflows/typos.yaml
ADDED
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: Typos
|
2 |
+
|
3 |
+
# Run on pull requests
|
4 |
+
on:
|
5 |
+
pull_request: {}
|
6 |
+
|
7 |
+
jobs:
|
8 |
+
typos:
|
9 |
+
name: Check for typos
|
10 |
+
runs-on: ubuntu-latest
|
11 |
+
steps:
|
12 |
+
- name: π Cancel Previous Runs
|
13 |
+
uses: styfle/[email protected]
|
14 |
+
- uses: actions/checkout@v4
|
15 |
+
- uses: crate-ci/[email protected]
|
16 |
+
name: Tests
|
README.md
CHANGED
Binary files a/README.md and b/README.md differ
|
|
python/README.md
CHANGED
@@ -1,2 +1,19 @@
|
|
1 |
-
|
2 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Learn Python
|
2 |
+
|
3 |
+
This collection of marimo notebooks is designed to teach you the basics
|
4 |
+
of the Python programming language.
|
5 |
+
|
6 |
+
**Running notebooks.** To run a notebook locally, use
|
7 |
+
|
8 |
+
```bash
|
9 |
+
uvx marimo edit <URL>
|
10 |
+
```
|
11 |
+
|
12 |
+
For example, run the numbers tutorial with
|
13 |
+
|
14 |
+
```bash
|
15 |
+
uvx marimo edit https://github.com/marimo-team/learn/blob/main/python/001_numbers.py
|
16 |
+
```
|
17 |
+
|
18 |
+
You can also open notebooks in our online playground by appending `marimo.app/`
|
19 |
+
to a notebook's URL: [marimo.app/https://github.com/marimo-team/learn/blob/main/python/001_numbers.py](https://github.com/marimo-team/learn/blob/main/python/001_numbers.py).
|