Skip to content

Commit c150785

Browse files
committed
readme tweaks
1 parent 90280f9 commit c150785

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,49 @@
33
This repository contains 771 Jupyter notebooks across 187 topics.
44
These notebooks are a mix of experiments, drafts, and useful scripts for data analysis, visualization, and storytelling.
55

6-
> **Note:** This is an older personal sandbox for learning and experimenting. Some notebooks may be incomplete or outdated.
6+
> **Note:** This is a personal sandbox for learning and experimenting. Some notebooks may be incomplete or outdated.
77
88
## 🛠️ Setting Up the Environment
99

1010
This repository uses [`uv`](https://github.com/astral-sh/uv) for dependency management.
1111

1212
### Install `uv`
13+
`uv` is a package manager for Python that simplifies the setup of virtual environments and dependency management.
14+
To install `uv`, follow the instructions on the [official website](https://astral.sh/uv/).
15+
16+
```bash
1317
brew install uv
18+
```
1419

1520
### Set up a Virtual Environment
21+
```bash
1622
export UV_VENV_PATH=".venv"
1723
uv venv
1824
source .venv/bin/activate
25+
```
1926

2027
### Install Dependencies
2128
If you have a `requirements.txt` file:
29+
```bash
2230
uv pip install -r requirements.txt
31+
```
2332

2433
For individual package installation:
34+
```bash
2535
uv add pandas numpy matplotlib jupyterlab
36+
```
2637

2738
### Run JupyterLab
39+
```bash
2840
uv run jupyter lab
41+
```
2942

3043
### Lock Dependencies for Reproducibility
44+
```bash
3145
uv lock
46+
```
3247

3348
### Sync Dependencies in a New Environment
49+
```bash
3450
uv sync
51+
```

generate_readme.py

+17
Original file line numberDiff line numberDiff line change
@@ -40,28 +40,45 @@ def generate_readme(topic_counts, total_notebooks):
4040
This repository uses [`uv`](https://github.com/astral-sh/uv) for dependency management.
4141
4242
### Install `uv`
43+
`uv` is a package manager for Python that simplifies the setup of virtual environments and dependency management.
44+
To install `uv`, follow the instructions on the [official website](https://astral.sh/uv/).
45+
46+
```bash
4347
brew install uv
48+
```
4449
4550
### Set up a Virtual Environment
51+
```bash
4652
export UV_VENV_PATH=".venv"
4753
uv venv
4854
source .venv/bin/activate
55+
```
4956
5057
### Install Dependencies
5158
If you have a `requirements.txt` file:
59+
```bash
5260
uv pip install -r requirements.txt
61+
```
5362
5463
For individual package installation:
64+
```bash
5565
uv add pandas numpy matplotlib jupyterlab
66+
```
5667
5768
### Run JupyterLab
69+
```bash
5870
uv run jupyter lab
71+
```
5972
6073
### Lock Dependencies for Reproducibility
74+
```bash
6175
uv lock
76+
```
6277
6378
### Sync Dependencies in a New Environment
79+
```bash
6480
uv sync
81+
```
6582
"""
6683

6784
return readme_content

0 commit comments

Comments
 (0)