Skip to content

Update README.md with post-launch details #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ehanson8 merged 1 commit into from
May 27, 2026
Merged

Update README.md with post-launch details #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# cdps-dashboard
A [Marimo notebook](https://marimo.io/) that uses S3 inventory data to display statistics about content in MIT Libraries' preservation storage. The analysis logic depends on Archivematica package and MIT Libraries file naming conventions. After launching the notebook, see the "About this notebook" section for more information.


## Developing
As this dashboard relies on S3 Inventory data, authenticate with `Dev1` credentials before editing.
Expand All @@ -9,6 +11,8 @@ The recommended approach for developing a Marimo notebook is to use the Marimo G
make edit-notebook
```

This [Confluence page](https://mitlibraries.atlassian.net/wiki/x/AYA3IgE) describes the update workflow for this notebook. All updates are done in coordination with and fully reviewed by the [DataEng team](https://github.com/orgs/MITLibraries/teams/dataeng).

### Testing
To run tests:

Expand All @@ -23,22 +27,23 @@ To run linting:
make lint
```

## Running
Often, notebooks are [served as an "app"](https://docs.marimo.io/guides/apps/). This is the default mode for [marimo-launcher](https://github.com/MITLibraries/marimo-launcher).

```shell
uv run marimo run --sandbox --headless --no-token notebook.py
```

## Environment Variables

### Required
```shell
S3_INVENTORY_LOCATIONS=# A comma-delimited list of S3 URIs containing S3 Inventory symlink.txt files.
DIGITIZED_BAG_IDS=# A list of bag IDs used by `is_digitized_aip` function. TO BE DEPRECATED IN FUTURE COMMITS
```

### Optional
```shell
# add optional env vars here...
```
```

## Running
Often, notebooks are [served as an "app"](https://docs.marimo.io/guides/apps/). This is the default mode for [marimo-launcher](https://github.com/MITLibraries/marimo-launcher).

```shell
uv run marimo run --sandbox --headless --no-token notebook.py
```

Access to an AWS-hosted notebook is managed through secrets stored in LastPass. For details on accessing this hosted notebook, visit this [Confluence page](https://mitlibraries.atlassian.net/wiki/x/AQCNFwE).
Loading
Loading