Skip to content

Commit 32144ec

Browse files
Update README.md
flowchart and images
1 parent cda71b9 commit 32144ec

1 file changed

Lines changed: 32 additions & 28 deletions

File tree

README.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,34 @@ The system works by treating your Git repository as a source of truth for *metad
1111
The workflow is as follows:
1212

1313
```mermaid
14+
---
15+
config:
16+
layout: elk
17+
theme: mc
18+
look: classic
19+
---
1420
flowchart TD
15-
subgraph "Local Machine / CI Runner"
16-
A[Developer] --> B{datamanager CLI};
17-
B --> C[Git Repo];
18-
C --> D[manifest.json];
19-
C --> E[.diff files];
20-
end
21-
22-
subgraph "Cloud"
23-
F[Remote Git Repo <br/>(GitHub, GitLab)];
24-
G[Cloudflare R2 Bucket];
25-
end
26-
27-
B -- "1. Uploads new .sqlite file" --> G;
28-
B -- "2. Calculates hash & diff" --> C;
29-
C -- "3. git push" --> F;
30-
31-
style G fill:#f9f,stroke:#333,stroke-width:2px
32-
style F fill:#ccf,stroke:#333,stroke-width:2px
21+
subgraph subGraph0["Local Machine / CI Runner"]
22+
B{"datamanager CLI"}
23+
A["Developer"]
24+
C["Git Repo"]
25+
D["manifest.json"]
26+
E[".diff files"]
27+
end
28+
subgraph Cloud["Cloud"]
29+
F["Remote Git Repo"]
30+
G["Cloudflare R2 Bucket"]
31+
end
32+
A --> B
33+
B --> C
34+
C --> D & E
35+
B -- "Uploads new .sqlite db" --> G
36+
B -- Calculates hash & diff --> C
37+
C -- git push --> F
38+
3339
```
3440

35-
A `manifest.json` file in the Git repo acts as a "pointer" system, mapping dataset versions to specific, immutable objects in R2, complete with integrity hashes.
41+
The `manifest.json` file in the Git repo acts as a "pointer" system, mapping dataset versions to specific, immutable objects in R2, complete with integrity hashes.
3642

3743
## Features
3844

@@ -93,10 +99,10 @@ A `manifest.json` file in the Git repo acts as a "pointer" system, mapping datas
9399
Run the `verify` command to ensure your credentials and bucket access are correct.
94100

95101
```bash
96-
datamanager verify
102+
uv run datamanager verify
97103
```
98104

99-
![Verify Output](assets/verification.png)
105+
![Verify Output](https://github.com/user-attachments/assets/f208e8a1-b70a-4cf7-a9ad-2e3a96a83265)
100106

101107
## 🚀 Usage
102108

@@ -110,7 +116,7 @@ uv run datamanager
110116

111117
This will launch a menu where you can choose your desired action.
112118

113-
![alt text](assets/tui.png)
119+
![TUI](https://github.com/user-attachments/assets/425572b3-9185-4889-ace7-ea882dcd9af5)
114120

115121
### Command-Line Interface (CLI)
116122

@@ -122,8 +128,6 @@ Checks R2 credentials and bucket access.
122128
uv run datamanager verify
123129
```
124130

125-
![alt text](assets/verification.png)
126-
127131
#### `list-datasets`
128132

129133
Lists all datasets currently tracked in `manifest.json`.
@@ -133,7 +137,7 @@ uv run datamanager list-datasets
133137
134138
```
135139

136-
![alt text](assets/list-datasets.png)
140+
![list_datasets](https://github.com/user-attachments/assets/c641a330-99a4-463a-a877-6698996edb27)
137141

138142
#### `create`
139143

@@ -143,7 +147,7 @@ Adds a new dataset to be tracked.
143147
uv run datamanager create <dataset-name.sqlite> <path/to/local/file.sqlite>
144148
```
145149

146-
![alt text](assets/creating.png)
150+
![adding database](https://github.com/user-attachments/assets/f43b991a-1ece-401b-956d-66c801705601)
147151

148152
#### `update`
149153

@@ -153,7 +157,7 @@ Creates a new version of an existing dataset.
153157
uv run datamanager update <dataset-name.sqlite> <path/to/new/file.sqlite>
154158
```
155159

156-
![alt text](assets/interactive_update.png)
160+
![updating databases](https://github.com/user-attachments/assets/330a667d-74f8-41d9-b26d-3c7de53dd873)
157161

158162
#### `pull`
159163

@@ -170,7 +174,7 @@ uv run datamanager pull user-profiles.sqlite --version v2
170174
uv run datamanager pull user-profiles.sqlite -o ./downloads/users_v2.sqlite
171175
```
172176

173-
![alt text](assets/pulling.png)
177+
![pulling](https://github.com/user-attachments/assets/275aae67-7bf3-47c2-90a4-db41cdc7e232)
174178

175179
## 🧑‍💻 Development and Testing
176180

0 commit comments

Comments
 (0)