A loose federation of distributed, typed datasets
1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
3
4<meta charset="utf-8">
5<meta name="generator" content="quarto-1.7.34">
6
7<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
8
9<meta name="description" content="Migrating datasets from local storage to ATProto">
10
11<title>Promotion Workflow – atdata</title>
12<style>
13code{white-space: pre-wrap;}
14span.smallcaps{font-variant: small-caps;}
15div.columns{display: flex; gap: min(4vw, 1.5em);}
16div.column{flex: auto; overflow-x: auto;}
17div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
18ul.task-list{list-style: none;}
19ul.task-list li input[type="checkbox"] {
20 width: 0.8em;
21 margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
22 vertical-align: middle;
23}
24/* CSS for syntax highlighting */
25html { -webkit-text-size-adjust: 100%; }
26pre > code.sourceCode { white-space: pre; position: relative; }
27pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
28pre > code.sourceCode > span:empty { height: 1.2em; }
29.sourceCode { overflow: visible; }
30code.sourceCode > span { color: inherit; text-decoration: inherit; }
31div.sourceCode { margin: 1em 0; }
32pre.sourceCode { margin: 0; }
33@media screen {
34div.sourceCode { overflow: auto; }
35}
36@media print {
37pre > code.sourceCode { white-space: pre-wrap; }
38pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
39}
40pre.numberSource code
41 { counter-reset: source-line 0; }
42pre.numberSource code > span
43 { position: relative; left: -4em; counter-increment: source-line; }
44pre.numberSource code > span > a:first-child::before
45 { content: counter(source-line);
46 position: relative; left: -1em; text-align: right; vertical-align: baseline;
47 border: none; display: inline-block;
48 -webkit-touch-callout: none; -webkit-user-select: none;
49 -khtml-user-select: none; -moz-user-select: none;
50 -ms-user-select: none; user-select: none;
51 padding: 0 4px; width: 4em;
52 }
53pre.numberSource { margin-left: 3em; padding-left: 4px; }
54div.sourceCode
55 { }
56@media screen {
57pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
58}
59</style>
60
61
62<script src="../site_libs/quarto-nav/quarto-nav.js"></script>
63<script src="../site_libs/quarto-nav/headroom.min.js"></script>
64<script src="../site_libs/clipboard/clipboard.min.js"></script>
65<script src="../site_libs/quarto-search/autocomplete.umd.js"></script>
66<script src="../site_libs/quarto-search/fuse.min.js"></script>
67<script src="../site_libs/quarto-search/quarto-search.js"></script>
68<meta name="quarto:offset" content="../">
69<script src="../site_libs/quarto-html/quarto.js" type="module"></script>
70<script src="../site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
71<script src="../site_libs/quarto-html/popper.min.js"></script>
72<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
73<script src="../site_libs/quarto-html/anchor.min.js"></script>
74<link href="../site_libs/quarto-html/tippy.css" rel="stylesheet">
75<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme" id="quarto-text-highlighting-styles">
76<link href="../site_libs/quarto-html/quarto-syntax-highlighting-dark-8dcd8563ea6803ab7cbb3d71ca5772e1.css" rel="stylesheet" class="quarto-color-scheme quarto-color-alternate" id="quarto-text-highlighting-styles">
77<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme-extra" id="quarto-text-highlighting-styles">
78<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
79<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
80<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme" id="quarto-bootstrap" data-mode="light">
81<link href="../site_libs/bootstrap/bootstrap-dark-7964ffd8887b0991fe8d71c6c8bc75d6.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme quarto-color-alternate" id="quarto-bootstrap" data-mode="dark">
82<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme-extra" id="quarto-bootstrap" data-mode="light">
83<script id="quarto-search-options" type="application/json">{
84 "location": "navbar",
85 "copy-button": false,
86 "collapse-after": 3,
87 "panel-placement": "end",
88 "type": "overlay",
89 "limit": 50,
90 "keyboard-shortcut": [
91 "f",
92 "/",
93 "s"
94 ],
95 "show-item-context": false,
96 "language": {
97 "search-no-results-text": "No results",
98 "search-matching-documents-text": "matching documents",
99 "search-copy-link-title": "Copy link to search",
100 "search-hide-matches-text": "Hide additional matches",
101 "search-more-match-text": "more match in this document",
102 "search-more-matches-text": "more matches in this document",
103 "search-clear-button-title": "Clear",
104 "search-text-placeholder": "",
105 "search-detached-cancel-button-title": "Cancel",
106 "search-submit-button-title": "Submit",
107 "search-label": "Search"
108 }
109}</script>
110
111
112<link rel="stylesheet" href="../assets/styles.css">
113</head>
114
115<body class="nav-sidebar docked nav-fixed quarto-light"><script id="quarto-html-before-body" type="application/javascript">
116 const toggleBodyColorMode = (bsSheetEl) => {
117 const mode = bsSheetEl.getAttribute("data-mode");
118 const bodyEl = window.document.querySelector("body");
119 if (mode === "dark") {
120 bodyEl.classList.add("quarto-dark");
121 bodyEl.classList.remove("quarto-light");
122 } else {
123 bodyEl.classList.add("quarto-light");
124 bodyEl.classList.remove("quarto-dark");
125 }
126 }
127 const toggleBodyColorPrimary = () => {
128 const bsSheetEl = window.document.querySelector("link#quarto-bootstrap:not([rel=disabled-stylesheet])");
129 if (bsSheetEl) {
130 toggleBodyColorMode(bsSheetEl);
131 }
132 }
133 const setColorSchemeToggle = (alternate) => {
134 const toggles = window.document.querySelectorAll('.quarto-color-scheme-toggle');
135 for (let i=0; i < toggles.length; i++) {
136 const toggle = toggles[i];
137 if (toggle) {
138 if (alternate) {
139 toggle.classList.add("alternate");
140 } else {
141 toggle.classList.remove("alternate");
142 }
143 }
144 }
145 };
146 const toggleColorMode = (alternate) => {
147 // Switch the stylesheets
148 const primaryStylesheets = window.document.querySelectorAll('link.quarto-color-scheme:not(.quarto-color-alternate)');
149 const alternateStylesheets = window.document.querySelectorAll('link.quarto-color-scheme.quarto-color-alternate');
150 manageTransitions('#quarto-margin-sidebar .nav-link', false);
151 if (alternate) {
152 // note: dark is layered on light, we don't disable primary!
153 enableStylesheet(alternateStylesheets);
154 for (const sheetNode of alternateStylesheets) {
155 if (sheetNode.id === "quarto-bootstrap") {
156 toggleBodyColorMode(sheetNode);
157 }
158 }
159 } else {
160 disableStylesheet(alternateStylesheets);
161 enableStylesheet(primaryStylesheets)
162 toggleBodyColorPrimary();
163 }
164 manageTransitions('#quarto-margin-sidebar .nav-link', true);
165 // Switch the toggles
166 setColorSchemeToggle(alternate)
167 // Hack to workaround the fact that safari doesn't
168 // properly recolor the scrollbar when toggling (#1455)
169 if (navigator.userAgent.indexOf('Safari') > 0 && navigator.userAgent.indexOf('Chrome') == -1) {
170 manageTransitions("body", false);
171 window.scrollTo(0, 1);
172 setTimeout(() => {
173 window.scrollTo(0, 0);
174 manageTransitions("body", true);
175 }, 40);
176 }
177 }
178 const disableStylesheet = (stylesheets) => {
179 for (let i=0; i < stylesheets.length; i++) {
180 const stylesheet = stylesheets[i];
181 stylesheet.rel = 'disabled-stylesheet';
182 }
183 }
184 const enableStylesheet = (stylesheets) => {
185 for (let i=0; i < stylesheets.length; i++) {
186 const stylesheet = stylesheets[i];
187 if(stylesheet.rel !== 'stylesheet') { // for Chrome, which will still FOUC without this check
188 stylesheet.rel = 'stylesheet';
189 }
190 }
191 }
192 const manageTransitions = (selector, allowTransitions) => {
193 const els = window.document.querySelectorAll(selector);
194 for (let i=0; i < els.length; i++) {
195 const el = els[i];
196 if (allowTransitions) {
197 el.classList.remove('notransition');
198 } else {
199 el.classList.add('notransition');
200 }
201 }
202 }
203 const isFileUrl = () => {
204 return window.location.protocol === 'file:';
205 }
206 const hasAlternateSentinel = () => {
207 let styleSentinel = getColorSchemeSentinel();
208 if (styleSentinel !== null) {
209 return styleSentinel === "alternate";
210 } else {
211 return false;
212 }
213 }
214 const setStyleSentinel = (alternate) => {
215 const value = alternate ? "alternate" : "default";
216 if (!isFileUrl()) {
217 window.localStorage.setItem("quarto-color-scheme", value);
218 } else {
219 localAlternateSentinel = value;
220 }
221 }
222 const getColorSchemeSentinel = () => {
223 if (!isFileUrl()) {
224 const storageValue = window.localStorage.getItem("quarto-color-scheme");
225 return storageValue != null ? storageValue : localAlternateSentinel;
226 } else {
227 return localAlternateSentinel;
228 }
229 }
230 const toggleGiscusIfUsed = (isAlternate, darkModeDefault) => {
231 const baseTheme = document.querySelector('#giscus-base-theme')?.value ?? 'light';
232 const alternateTheme = document.querySelector('#giscus-alt-theme')?.value ?? 'dark';
233 let newTheme = '';
234 if(authorPrefersDark) {
235 newTheme = isAlternate ? baseTheme : alternateTheme;
236 } else {
237 newTheme = isAlternate ? alternateTheme : baseTheme;
238 }
239 const changeGiscusTheme = () => {
240 // From: https://github.com/giscus/giscus/issues/336
241 const sendMessage = (message) => {
242 const iframe = document.querySelector('iframe.giscus-frame');
243 if (!iframe) return;
244 iframe.contentWindow.postMessage({ giscus: message }, 'https://giscus.app');
245 }
246 sendMessage({
247 setConfig: {
248 theme: newTheme
249 }
250 });
251 }
252 const isGiscussLoaded = window.document.querySelector('iframe.giscus-frame') !== null;
253 if (isGiscussLoaded) {
254 changeGiscusTheme();
255 }
256 };
257 const authorPrefersDark = false;
258 const darkModeDefault = authorPrefersDark;
259 document.querySelector('link#quarto-text-highlighting-styles.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
260 document.querySelector('link#quarto-bootstrap.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
261 let localAlternateSentinel = darkModeDefault ? 'alternate' : 'default';
262 // Dark / light mode switch
263 window.quartoToggleColorScheme = () => {
264 // Read the current dark / light value
265 let toAlternate = !hasAlternateSentinel();
266 toggleColorMode(toAlternate);
267 setStyleSentinel(toAlternate);
268 toggleGiscusIfUsed(toAlternate, darkModeDefault);
269 window.dispatchEvent(new Event('resize'));
270 };
271 // Switch to dark mode if need be
272 if (hasAlternateSentinel()) {
273 toggleColorMode(true);
274 } else {
275 toggleColorMode(false);
276 }
277 </script>
278
279<div id="quarto-search-results"></div>
280 <header id="quarto-header" class="headroom fixed-top">
281 <nav class="navbar navbar-expand-lg " data-bs-theme="dark">
282 <div class="navbar-container container-fluid">
283 <div class="navbar-brand-container mx-auto">
284 <a class="navbar-brand" href="../index.html">
285 <span class="navbar-title">atdata</span>
286 </a>
287 </div>
288 <div id="quarto-search" class="" title="Search"></div>
289 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" role="menu" aria-expanded="false" aria-label="Toggle navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
290 <span class="navbar-toggler-icon"></span>
291</button>
292 <div class="collapse navbar-collapse" id="navbarCollapse">
293 <ul class="navbar-nav navbar-nav-scroll me-auto">
294 <li class="nav-item">
295 <a class="nav-link active" href="../index.html" aria-current="page">
296<span class="menu-text">Guide</span></a>
297 </li>
298 <li class="nav-item dropdown ">
299 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-tutorials" role="link" data-bs-toggle="dropdown" aria-expanded="false">
300 <span class="menu-text">Tutorials</span>
301 </a>
302 <ul class="dropdown-menu" aria-labelledby="nav-menu-tutorials">
303 <li>
304 <a class="dropdown-item" href="../tutorials/quickstart.html">
305 <span class="dropdown-text">Quick Start</span></a>
306 </li>
307 <li>
308 <a class="dropdown-item" href="../tutorials/local-workflow.html">
309 <span class="dropdown-text">Local Workflow</span></a>
310 </li>
311 <li>
312 <a class="dropdown-item" href="../tutorials/atmosphere.html">
313 <span class="dropdown-text">Atmosphere Publishing</span></a>
314 </li>
315 <li>
316 <a class="dropdown-item" href="../tutorials/promotion.html">
317 <span class="dropdown-text">Promotion Workflow</span></a>
318 </li>
319 </ul>
320 </li>
321 <li class="nav-item dropdown ">
322 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-reference" role="link" data-bs-toggle="dropdown" aria-expanded="false">
323 <span class="menu-text">Reference</span>
324 </a>
325 <ul class="dropdown-menu" aria-labelledby="nav-menu-reference">
326 <li>
327 <a class="dropdown-item" href="../reference/architecture.html">
328 <span class="dropdown-text">Architecture Overview</span></a>
329 </li>
330 <li>
331 <a class="dropdown-item" href="../reference/packable-samples.html">
332 <span class="dropdown-text">Packable Samples</span></a>
333 </li>
334 <li>
335 <a class="dropdown-item" href="../reference/datasets.html">
336 <span class="dropdown-text">Datasets</span></a>
337 </li>
338 <li>
339 <a class="dropdown-item" href="../reference/lenses.html">
340 <span class="dropdown-text">Lenses</span></a>
341 </li>
342 <li>
343 <a class="dropdown-item" href="../reference/local-storage.html">
344 <span class="dropdown-text">Local Storage</span></a>
345 </li>
346 <li>
347 <a class="dropdown-item" href="../reference/atmosphere.html">
348 <span class="dropdown-text">Atmosphere</span></a>
349 </li>
350 <li>
351 <a class="dropdown-item" href="../reference/promotion.html">
352 <span class="dropdown-text">Promotion</span></a>
353 </li>
354 <li>
355 <a class="dropdown-item" href="../reference/load-dataset.html">
356 <span class="dropdown-text">load_dataset API</span></a>
357 </li>
358 <li>
359 <a class="dropdown-item" href="../reference/protocols.html">
360 <span class="dropdown-text">Protocols</span></a>
361 </li>
362 <li>
363 <a class="dropdown-item" href="../reference/uri-spec.html">
364 <span class="dropdown-text">URI Specification</span></a>
365 </li>
366 <li>
367 <a class="dropdown-item" href="../reference/troubleshooting.html">
368 <span class="dropdown-text">Troubleshooting & FAQ</span></a>
369 </li>
370 <li>
371 <a class="dropdown-item" href="../reference/deployment.html">
372 <span class="dropdown-text">Deployment Guide</span></a>
373 </li>
374 </ul>
375 </li>
376 <li class="nav-item">
377 <a class="nav-link" href="../api/index.html">
378<span class="menu-text">API</span></a>
379 </li>
380</ul>
381 <ul class="navbar-nav navbar-nav-scroll ms-auto">
382 <li class="nav-item compact">
383 <a class="nav-link" href="https://github.com/your-org/atdata"> <i class="bi bi-github" role="img">
384</i>
385<span class="menu-text"></span></a>
386 </li>
387</ul>
388 </div> <!-- /navcollapse -->
389 <div class="quarto-navbar-tools">
390 <a href="" class="quarto-color-scheme-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleColorScheme(); return false;" title="Toggle dark mode"><i class="bi"></i></a>
391</div>
392 </div> <!-- /container-fluid -->
393 </nav>
394 <nav class="quarto-secondary-nav">
395 <div class="container-fluid d-flex">
396 <button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
397 <i class="bi bi-layout-text-sidebar-reverse"></i>
398 </button>
399 <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../reference/architecture.html">Reference</a></li><li class="breadcrumb-item"><a href="../reference/promotion.html">Promotion Workflow</a></li></ol></nav>
400 <a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
401 </a>
402 </div>
403 </nav>
404</header>
405<!-- content -->
406<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
407<!-- sidebar -->
408 <nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal quarto-sidebar-collapse-item sidebar-navigation docked overflow-auto">
409 <div class="sidebar-menu-container">
410 <ul class="list-unstyled mt-1">
411 <li class="sidebar-item">
412 <div class="sidebar-item-container">
413 <a href="../index.html" class="sidebar-item-text sidebar-link">
414 <span class="menu-text">atdata</span></a>
415 </div>
416</li>
417 <li class="sidebar-item sidebar-item-section">
418 <div class="sidebar-item-container">
419 <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
420 <span class="menu-text">Getting Started</span></a>
421 <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
422 <i class="bi bi-chevron-right ms-2"></i>
423 </a>
424 </div>
425 <ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
426 <li class="sidebar-item">
427 <div class="sidebar-item-container">
428 <a href="../tutorials/quickstart.html" class="sidebar-item-text sidebar-link">
429 <span class="menu-text">Quick Start</span></a>
430 </div>
431</li>
432 <li class="sidebar-item">
433 <div class="sidebar-item-container">
434 <a href="../tutorials/local-workflow.html" class="sidebar-item-text sidebar-link">
435 <span class="menu-text">Local Workflow</span></a>
436 </div>
437</li>
438 <li class="sidebar-item">
439 <div class="sidebar-item-container">
440 <a href="../tutorials/atmosphere.html" class="sidebar-item-text sidebar-link">
441 <span class="menu-text">Atmosphere Publishing</span></a>
442 </div>
443</li>
444 <li class="sidebar-item">
445 <div class="sidebar-item-container">
446 <a href="../tutorials/promotion.html" class="sidebar-item-text sidebar-link">
447 <span class="menu-text">Promotion Workflow</span></a>
448 </div>
449</li>
450 </ul>
451 </li>
452 <li class="sidebar-item sidebar-item-section">
453 <div class="sidebar-item-container">
454 <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
455 <span class="menu-text">Reference</span></a>
456 <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
457 <i class="bi bi-chevron-right ms-2"></i>
458 </a>
459 </div>
460 <ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
461 <li class="sidebar-item">
462 <div class="sidebar-item-container">
463 <a href="../reference/architecture.html" class="sidebar-item-text sidebar-link">
464 <span class="menu-text">Architecture Overview</span></a>
465 </div>
466</li>
467 <li class="sidebar-item">
468 <div class="sidebar-item-container">
469 <a href="../reference/packable-samples.html" class="sidebar-item-text sidebar-link">
470 <span class="menu-text">Packable Samples</span></a>
471 </div>
472</li>
473 <li class="sidebar-item">
474 <div class="sidebar-item-container">
475 <a href="../reference/datasets.html" class="sidebar-item-text sidebar-link">
476 <span class="menu-text">Datasets</span></a>
477 </div>
478</li>
479 <li class="sidebar-item">
480 <div class="sidebar-item-container">
481 <a href="../reference/lenses.html" class="sidebar-item-text sidebar-link">
482 <span class="menu-text">Lenses</span></a>
483 </div>
484</li>
485 <li class="sidebar-item">
486 <div class="sidebar-item-container">
487 <a href="../reference/local-storage.html" class="sidebar-item-text sidebar-link">
488 <span class="menu-text">Local Storage</span></a>
489 </div>
490</li>
491 <li class="sidebar-item">
492 <div class="sidebar-item-container">
493 <a href="../reference/atmosphere.html" class="sidebar-item-text sidebar-link">
494 <span class="menu-text">Atmosphere (ATProto Integration)</span></a>
495 </div>
496</li>
497 <li class="sidebar-item">
498 <div class="sidebar-item-container">
499 <a href="../reference/promotion.html" class="sidebar-item-text sidebar-link active">
500 <span class="menu-text">Promotion Workflow</span></a>
501 </div>
502</li>
503 <li class="sidebar-item">
504 <div class="sidebar-item-container">
505 <a href="../reference/load-dataset.html" class="sidebar-item-text sidebar-link">
506 <span class="menu-text">load_dataset API</span></a>
507 </div>
508</li>
509 <li class="sidebar-item">
510 <div class="sidebar-item-container">
511 <a href="../reference/protocols.html" class="sidebar-item-text sidebar-link">
512 <span class="menu-text">Protocols</span></a>
513 </div>
514</li>
515 <li class="sidebar-item">
516 <div class="sidebar-item-container">
517 <a href="../reference/uri-spec.html" class="sidebar-item-text sidebar-link">
518 <span class="menu-text">URI Specification</span></a>
519 </div>
520</li>
521 <li class="sidebar-item">
522 <div class="sidebar-item-container">
523 <a href="../reference/troubleshooting.html" class="sidebar-item-text sidebar-link">
524 <span class="menu-text">Troubleshooting & FAQ</span></a>
525 </div>
526</li>
527 <li class="sidebar-item">
528 <div class="sidebar-item-container">
529 <a href="../reference/deployment.html" class="sidebar-item-text sidebar-link">
530 <span class="menu-text">Deployment Guide</span></a>
531 </div>
532</li>
533 </ul>
534 </li>
535 </ul>
536 </div>
537</nav>
538<div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div>
539<!-- margin-sidebar -->
540 <div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
541 <nav id="TOC" role="doc-toc" class="toc-active">
542 <h2 id="toc-title">On this page</h2>
543
544 <ul>
545 <li><a href="#overview" id="toc-overview" class="nav-link active" data-scroll-target="#overview">Overview</a></li>
546 <li><a href="#basic-usage" id="toc-basic-usage" class="nav-link" data-scroll-target="#basic-usage">Basic Usage</a></li>
547 <li><a href="#with-metadata" id="toc-with-metadata" class="nav-link" data-scroll-target="#with-metadata">With Metadata</a></li>
548 <li><a href="#schema-deduplication" id="toc-schema-deduplication" class="nav-link" data-scroll-target="#schema-deduplication">Schema Deduplication</a></li>
549 <li><a href="#data-storage-options" id="toc-data-storage-options" class="nav-link" data-scroll-target="#data-storage-options">Data Storage Options</a></li>
550 <li><a href="#complete-workflow-example" id="toc-complete-workflow-example" class="nav-link" data-scroll-target="#complete-workflow-example">Complete Workflow Example</a></li>
551 <li><a href="#error-handling" id="toc-error-handling" class="nav-link" data-scroll-target="#error-handling">Error Handling</a></li>
552 <li><a href="#requirements" id="toc-requirements" class="nav-link" data-scroll-target="#requirements">Requirements</a></li>
553 <li><a href="#related" id="toc-related" class="nav-link" data-scroll-target="#related">Related</a></li>
554 </ul>
555<div class="toc-actions"><ul><li><a href="https://github.com/your-org/atdata/edit/main/reference/promotion.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/your-org/atdata/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
556 </div>
557<!-- main -->
558<main class="content" id="quarto-document-content">
559
560
561<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../reference/architecture.html">Reference</a></li><li class="breadcrumb-item"><a href="../reference/promotion.html">Promotion Workflow</a></li></ol></nav>
562<div class="quarto-title">
563<h1 class="title">Promotion Workflow</h1>
564</div>
565
566<div>
567 <div class="description">
568 Migrating datasets from local storage to ATProto
569 </div>
570</div>
571
572
573<div class="quarto-title-meta">
574
575
576
577
578 </div>
579
580
581
582</header>
583
584
585<p>The promotion workflow migrates datasets from local storage (Redis + S3) to the ATProto atmosphere network, enabling federation and discovery.</p>
586<section id="overview" class="level2">
587<h2 class="anchored" data-anchor-id="overview">Overview</h2>
588<p>Promotion handles:</p>
589<ul>
590<li><strong>Schema deduplication</strong>: Avoids publishing duplicate schemas</li>
591<li><strong>Data URL preservation</strong>: Keeps existing S3 URLs or copies to new storage</li>
592<li><strong>Metadata transfer</strong>: Preserves tags, descriptions, and custom metadata</li>
593</ul>
594</section>
595<section id="basic-usage" class="level2">
596<h2 class="anchored" data-anchor-id="basic-usage">Basic Usage</h2>
597<div id="f83bcdc2" class="cell">
598<div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.local <span class="im">import</span> LocalIndex</span>
599<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.atmosphere <span class="im">import</span> AtmosphereClient</span>
600<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.promote <span class="im">import</span> promote_to_atmosphere</span>
601<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a></span>
602<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a><span class="co"># Setup</span></span>
603<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a>local_index <span class="op">=</span> LocalIndex()</span>
604<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a>client <span class="op">=</span> AtmosphereClient()</span>
605<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a>client.login(<span class="st">"handle.bsky.social"</span>, <span class="st">"app-password"</span>)</span>
606<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a></span>
607<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a><span class="co"># Get local entry</span></span>
608<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a>entry <span class="op">=</span> local_index.get_entry_by_name(<span class="st">"my-dataset"</span>)</span>
609<span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a></span>
610<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a><span class="co"># Promote to atmosphere</span></span>
611<span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a>at_uri <span class="op">=</span> promote_to_atmosphere(entry, local_index, client)</span>
612<span id="cb1-15"><a href="#cb1-15" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Published: </span><span class="sc">{</span>at_uri<span class="sc">}</span><span class="ss">"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
613</div>
614</section>
615<section id="with-metadata" class="level2">
616<h2 class="anchored" data-anchor-id="with-metadata">With Metadata</h2>
617<div id="3b1395cf" class="cell">
618<div class="sourceCode cell-code" id="cb2"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>at_uri <span class="op">=</span> promote_to_atmosphere(</span>
619<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> entry,</span>
620<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> local_index,</span>
621<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a> client,</span>
622<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a> name<span class="op">=</span><span class="st">"my-dataset-v2"</span>, <span class="co"># Override name</span></span>
623<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a> description<span class="op">=</span><span class="st">"Training images"</span>, <span class="co"># Add description</span></span>
624<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a> tags<span class="op">=</span>[<span class="st">"images"</span>, <span class="st">"training"</span>], <span class="co"># Add discovery tags</span></span>
625<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a> license<span class="op">=</span><span class="st">"MIT"</span>, <span class="co"># Specify license</span></span>
626<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
627</div>
628</section>
629<section id="schema-deduplication" class="level2">
630<h2 class="anchored" data-anchor-id="schema-deduplication">Schema Deduplication</h2>
631<p>The promotion workflow automatically checks for existing schemas:</p>
632<div id="509d97ed" class="cell">
633<div class="sourceCode cell-code" id="cb3"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="co"># First promotion: publishes schema</span></span>
634<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a>uri1 <span class="op">=</span> promote_to_atmosphere(entry1, local_index, client)</span>
635<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a></span>
636<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a><span class="co"># Second promotion with same schema type + version: reuses existing schema</span></span>
637<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a>uri2 <span class="op">=</span> promote_to_atmosphere(entry2, local_index, client)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
638</div>
639<p>Schema matching is based on:</p>
640<ul>
641<li><code>{module}.{class_name}</code> (e.g., <code>mymodule.ImageSample</code>)</li>
642<li>Version string (e.g., <code>1.0.0</code>)</li>
643</ul>
644</section>
645<section id="data-storage-options" class="level2">
646<h2 class="anchored" data-anchor-id="data-storage-options">Data Storage Options</h2>
647<div class="tabset-margin-container"></div><div class="panel-tabset">
648<ul class="nav nav-tabs" role="tablist"><li class="nav-item" role="presentation"><a class="nav-link active" id="tabset-1-1-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-1" role="tab" aria-controls="tabset-1-1" aria-selected="true">Keep Existing URLs (Default)</a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-2-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-2" role="tab" aria-controls="tabset-1-2" aria-selected="false">Copy to New Storage</a></li></ul>
649<div class="tab-content">
650<div id="tabset-1-1" class="tab-pane active" role="tabpanel" aria-labelledby="tabset-1-1-tab">
651<p>By default, promotion keeps the original data URLs:</p>
652<div id="85fac1e6" class="cell">
653<div class="sourceCode cell-code" id="cb4"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Data stays in original S3 location</span></span>
654<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a>at_uri <span class="op">=</span> promote_to_atmosphere(entry, local_index, client)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
655</div>
656<ul>
657<li>Data stays in original S3 location</li>
658<li>Dataset record points to existing URLs</li>
659<li>Fastest option, no data copying</li>
660<li>Requires original storage to remain accessible</li>
661</ul>
662</div>
663<div id="tabset-1-2" class="tab-pane" role="tabpanel" aria-labelledby="tabset-1-2-tab">
664<p>To copy data to a different storage location:</p>
665<div id="84eeff63" class="cell">
666<div class="sourceCode cell-code" id="cb5"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.local <span class="im">import</span> S3DataStore</span>
667<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a></span>
668<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Create new data store</span></span>
669<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a>new_store <span class="op">=</span> S3DataStore(</span>
670<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a> credentials<span class="op">=</span><span class="st">"new-s3-creds.env"</span>,</span>
671<span id="cb5-6"><a href="#cb5-6" aria-hidden="true" tabindex="-1"></a> bucket<span class="op">=</span><span class="st">"public-datasets"</span>,</span>
672<span id="cb5-7"><a href="#cb5-7" aria-hidden="true" tabindex="-1"></a>)</span>
673<span id="cb5-8"><a href="#cb5-8" aria-hidden="true" tabindex="-1"></a></span>
674<span id="cb5-9"><a href="#cb5-9" aria-hidden="true" tabindex="-1"></a><span class="co"># Promote with data copy</span></span>
675<span id="cb5-10"><a href="#cb5-10" aria-hidden="true" tabindex="-1"></a>at_uri <span class="op">=</span> promote_to_atmosphere(</span>
676<span id="cb5-11"><a href="#cb5-11" aria-hidden="true" tabindex="-1"></a> entry,</span>
677<span id="cb5-12"><a href="#cb5-12" aria-hidden="true" tabindex="-1"></a> local_index,</span>
678<span id="cb5-13"><a href="#cb5-13" aria-hidden="true" tabindex="-1"></a> client,</span>
679<span id="cb5-14"><a href="#cb5-14" aria-hidden="true" tabindex="-1"></a> data_store<span class="op">=</span>new_store, <span class="co"># Copy data to new storage</span></span>
680<span id="cb5-15"><a href="#cb5-15" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
681</div>
682<ul>
683<li>Data is copied to new bucket</li>
684<li>Dataset record points to new URLs</li>
685<li>Good for moving from private to public storage</li>
686</ul>
687</div>
688</div>
689</div>
690</section>
691<section id="complete-workflow-example" class="level2">
692<h2 class="anchored" data-anchor-id="complete-workflow-example">Complete Workflow Example</h2>
693<div id="8f45fa86" class="cell">
694<div class="sourceCode cell-code" id="cb6"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> numpy <span class="im">as</span> np</span>
695<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> numpy.typing <span class="im">import</span> NDArray</span>
696<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> atdata</span>
697<span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.local <span class="im">import</span> LocalIndex, S3DataStore</span>
698<span id="cb6-5"><a href="#cb6-5" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.atmosphere <span class="im">import</span> AtmosphereClient</span>
699<span id="cb6-6"><a href="#cb6-6" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.promote <span class="im">import</span> promote_to_atmosphere</span>
700<span id="cb6-7"><a href="#cb6-7" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> webdataset <span class="im">as</span> wds</span>
701<span id="cb6-8"><a href="#cb6-8" aria-hidden="true" tabindex="-1"></a></span>
702<span id="cb6-9"><a href="#cb6-9" aria-hidden="true" tabindex="-1"></a><span class="co"># 1. Define sample type</span></span>
703<span id="cb6-10"><a href="#cb6-10" aria-hidden="true" tabindex="-1"></a><span class="at">@atdata.packable</span></span>
704<span id="cb6-11"><a href="#cb6-11" aria-hidden="true" tabindex="-1"></a><span class="kw">class</span> FeatureSample:</span>
705<span id="cb6-12"><a href="#cb6-12" aria-hidden="true" tabindex="-1"></a> features: NDArray</span>
706<span id="cb6-13"><a href="#cb6-13" aria-hidden="true" tabindex="-1"></a> label: <span class="bu">int</span></span>
707<span id="cb6-14"><a href="#cb6-14" aria-hidden="true" tabindex="-1"></a></span>
708<span id="cb6-15"><a href="#cb6-15" aria-hidden="true" tabindex="-1"></a><span class="co"># 2. Create local dataset</span></span>
709<span id="cb6-16"><a href="#cb6-16" aria-hidden="true" tabindex="-1"></a>samples <span class="op">=</span> [</span>
710<span id="cb6-17"><a href="#cb6-17" aria-hidden="true" tabindex="-1"></a> FeatureSample(</span>
711<span id="cb6-18"><a href="#cb6-18" aria-hidden="true" tabindex="-1"></a> features<span class="op">=</span>np.random.randn(<span class="dv">128</span>).astype(np.float32),</span>
712<span id="cb6-19"><a href="#cb6-19" aria-hidden="true" tabindex="-1"></a> label<span class="op">=</span>i <span class="op">%</span> <span class="dv">10</span>,</span>
713<span id="cb6-20"><a href="#cb6-20" aria-hidden="true" tabindex="-1"></a> )</span>
714<span id="cb6-21"><a href="#cb6-21" aria-hidden="true" tabindex="-1"></a> <span class="cf">for</span> i <span class="kw">in</span> <span class="bu">range</span>(<span class="dv">1000</span>)</span>
715<span id="cb6-22"><a href="#cb6-22" aria-hidden="true" tabindex="-1"></a>]</span>
716<span id="cb6-23"><a href="#cb6-23" aria-hidden="true" tabindex="-1"></a></span>
717<span id="cb6-24"><a href="#cb6-24" aria-hidden="true" tabindex="-1"></a><span class="cf">with</span> wds.writer.TarWriter(<span class="st">"features.tar"</span>) <span class="im">as</span> sink:</span>
718<span id="cb6-25"><a href="#cb6-25" aria-hidden="true" tabindex="-1"></a> <span class="cf">for</span> i, s <span class="kw">in</span> <span class="bu">enumerate</span>(samples):</span>
719<span id="cb6-26"><a href="#cb6-26" aria-hidden="true" tabindex="-1"></a> sink.write({<span class="op">**</span>s.as_wds, <span class="st">"__key__"</span>: <span class="ss">f"</span><span class="sc">{</span>i<span class="sc">:06d}</span><span class="ss">"</span>})</span>
720<span id="cb6-27"><a href="#cb6-27" aria-hidden="true" tabindex="-1"></a></span>
721<span id="cb6-28"><a href="#cb6-28" aria-hidden="true" tabindex="-1"></a><span class="co"># 3. Set up index with S3 data store</span></span>
722<span id="cb6-29"><a href="#cb6-29" aria-hidden="true" tabindex="-1"></a>store <span class="op">=</span> S3DataStore(</span>
723<span id="cb6-30"><a href="#cb6-30" aria-hidden="true" tabindex="-1"></a> credentials<span class="op">=</span>{</span>
724<span id="cb6-31"><a href="#cb6-31" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_ENDPOINT"</span>: <span class="st">"http://localhost:9000"</span>,</span>
725<span id="cb6-32"><a href="#cb6-32" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_ACCESS_KEY_ID"</span>: <span class="st">"minioadmin"</span>,</span>
726<span id="cb6-33"><a href="#cb6-33" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_SECRET_ACCESS_KEY"</span>: <span class="st">"minioadmin"</span>,</span>
727<span id="cb6-34"><a href="#cb6-34" aria-hidden="true" tabindex="-1"></a> },</span>
728<span id="cb6-35"><a href="#cb6-35" aria-hidden="true" tabindex="-1"></a> bucket<span class="op">=</span><span class="st">"datasets-bucket"</span>,</span>
729<span id="cb6-36"><a href="#cb6-36" aria-hidden="true" tabindex="-1"></a>)</span>
730<span id="cb6-37"><a href="#cb6-37" aria-hidden="true" tabindex="-1"></a>local_index <span class="op">=</span> LocalIndex(data_store<span class="op">=</span>store)</span>
731<span id="cb6-38"><a href="#cb6-38" aria-hidden="true" tabindex="-1"></a></span>
732<span id="cb6-39"><a href="#cb6-39" aria-hidden="true" tabindex="-1"></a><span class="co"># 4. Publish schema and insert dataset</span></span>
733<span id="cb6-40"><a href="#cb6-40" aria-hidden="true" tabindex="-1"></a>local_index.publish_schema(FeatureSample, version<span class="op">=</span><span class="st">"1.0.0"</span>)</span>
734<span id="cb6-41"><a href="#cb6-41" aria-hidden="true" tabindex="-1"></a>dataset <span class="op">=</span> atdata.Dataset[FeatureSample](<span class="st">"features.tar"</span>)</span>
735<span id="cb6-42"><a href="#cb6-42" aria-hidden="true" tabindex="-1"></a>local_entry <span class="op">=</span> local_index.insert_dataset(dataset, name<span class="op">=</span><span class="st">"feature-vectors-v1"</span>, prefix<span class="op">=</span><span class="st">"features"</span>)</span>
736<span id="cb6-43"><a href="#cb6-43" aria-hidden="true" tabindex="-1"></a></span>
737<span id="cb6-44"><a href="#cb6-44" aria-hidden="true" tabindex="-1"></a><span class="co"># 5. Promote to atmosphere</span></span>
738<span id="cb6-45"><a href="#cb6-45" aria-hidden="true" tabindex="-1"></a>client <span class="op">=</span> AtmosphereClient()</span>
739<span id="cb6-46"><a href="#cb6-46" aria-hidden="true" tabindex="-1"></a>client.login(<span class="st">"myhandle.bsky.social"</span>, <span class="st">"app-password"</span>)</span>
740<span id="cb6-47"><a href="#cb6-47" aria-hidden="true" tabindex="-1"></a></span>
741<span id="cb6-48"><a href="#cb6-48" aria-hidden="true" tabindex="-1"></a>at_uri <span class="op">=</span> promote_to_atmosphere(</span>
742<span id="cb6-49"><a href="#cb6-49" aria-hidden="true" tabindex="-1"></a> local_entry,</span>
743<span id="cb6-50"><a href="#cb6-50" aria-hidden="true" tabindex="-1"></a> local_index,</span>
744<span id="cb6-51"><a href="#cb6-51" aria-hidden="true" tabindex="-1"></a> client,</span>
745<span id="cb6-52"><a href="#cb6-52" aria-hidden="true" tabindex="-1"></a> description<span class="op">=</span><span class="st">"Feature vectors for classification"</span>,</span>
746<span id="cb6-53"><a href="#cb6-53" aria-hidden="true" tabindex="-1"></a> tags<span class="op">=</span>[<span class="st">"features"</span>, <span class="st">"embeddings"</span>],</span>
747<span id="cb6-54"><a href="#cb6-54" aria-hidden="true" tabindex="-1"></a> license<span class="op">=</span><span class="st">"MIT"</span>,</span>
748<span id="cb6-55"><a href="#cb6-55" aria-hidden="true" tabindex="-1"></a>)</span>
749<span id="cb6-56"><a href="#cb6-56" aria-hidden="true" tabindex="-1"></a></span>
750<span id="cb6-57"><a href="#cb6-57" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Dataset published: </span><span class="sc">{</span>at_uri<span class="sc">}</span><span class="ss">"</span>)</span>
751<span id="cb6-58"><a href="#cb6-58" aria-hidden="true" tabindex="-1"></a></span>
752<span id="cb6-59"><a href="#cb6-59" aria-hidden="true" tabindex="-1"></a><span class="co"># 6. Verify on atmosphere</span></span>
753<span id="cb6-60"><a href="#cb6-60" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.atmosphere <span class="im">import</span> AtmosphereIndex</span>
754<span id="cb6-61"><a href="#cb6-61" aria-hidden="true" tabindex="-1"></a></span>
755<span id="cb6-62"><a href="#cb6-62" aria-hidden="true" tabindex="-1"></a>atm_index <span class="op">=</span> AtmosphereIndex(client)</span>
756<span id="cb6-63"><a href="#cb6-63" aria-hidden="true" tabindex="-1"></a>entry <span class="op">=</span> atm_index.get_dataset(at_uri)</span>
757<span id="cb6-64"><a href="#cb6-64" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Name: </span><span class="sc">{</span>entry<span class="sc">.</span>name<span class="sc">}</span><span class="ss">"</span>)</span>
758<span id="cb6-65"><a href="#cb6-65" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Schema: </span><span class="sc">{</span>entry<span class="sc">.</span>schema_ref<span class="sc">}</span><span class="ss">"</span>)</span>
759<span id="cb6-66"><a href="#cb6-66" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"URLs: </span><span class="sc">{</span>entry<span class="sc">.</span>data_urls<span class="sc">}</span><span class="ss">"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
760</div>
761</section>
762<section id="error-handling" class="level2">
763<h2 class="anchored" data-anchor-id="error-handling">Error Handling</h2>
764<div id="2431b20a" class="cell">
765<div class="sourceCode cell-code" id="cb7"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="cf">try</span>:</span>
766<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a> at_uri <span class="op">=</span> promote_to_atmosphere(entry, local_index, client)</span>
767<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a><span class="cf">except</span> <span class="pp">KeyError</span> <span class="im">as</span> e:</span>
768<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a> <span class="co"># Schema not found in local index</span></span>
769<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a> <span class="bu">print</span>(<span class="ss">f"Missing schema: </span><span class="sc">{</span>e<span class="sc">}</span><span class="ss">"</span>)</span>
770<span id="cb7-6"><a href="#cb7-6" aria-hidden="true" tabindex="-1"></a><span class="cf">except</span> <span class="pp">ValueError</span> <span class="im">as</span> e:</span>
771<span id="cb7-7"><a href="#cb7-7" aria-hidden="true" tabindex="-1"></a> <span class="co"># Entry has no data URLs</span></span>
772<span id="cb7-8"><a href="#cb7-8" aria-hidden="true" tabindex="-1"></a> <span class="bu">print</span>(<span class="ss">f"Invalid entry: </span><span class="sc">{</span>e<span class="sc">}</span><span class="ss">"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
773</div>
774</section>
775<section id="requirements" class="level2">
776<h2 class="anchored" data-anchor-id="requirements">Requirements</h2>
777<p>Before promotion:</p>
778<ol type="1">
779<li>Dataset must be in local index (via <code>Index.insert_dataset()</code> or <code>Index.add_entry()</code>)</li>
780<li>Schema must be published to local index (via <code>Index.publish_schema()</code>)</li>
781<li>AtmosphereClient must be authenticated</li>
782</ol>
783</section>
784<section id="related" class="level2">
785<h2 class="anchored" data-anchor-id="related">Related</h2>
786<ul>
787<li><a href="../reference/local-storage.html">Local Storage</a> - Setting up local datasets</li>
788<li><a href="../reference/atmosphere.html">Atmosphere</a> - ATProto integration</li>
789<li><a href="../reference/protocols.html">Protocols</a> - AbstractIndex and AbstractDataStore</li>
790</ul>
791
792
793</section>
794
795</main> <!-- /main -->
796<script id="quarto-html-after-body" type="application/javascript">
797 window.document.addEventListener("DOMContentLoaded", function (event) {
798 // Ensure there is a toggle, if there isn't float one in the top right
799 if (window.document.querySelector('.quarto-color-scheme-toggle') === null) {
800 const a = window.document.createElement('a');
801 a.classList.add('top-right');
802 a.classList.add('quarto-color-scheme-toggle');
803 a.href = "";
804 a.onclick = function() { try { window.quartoToggleColorScheme(); } catch {} return false; };
805 const i = window.document.createElement("i");
806 i.classList.add('bi');
807 a.appendChild(i);
808 window.document.body.appendChild(a);
809 }
810 setColorSchemeToggle(hasAlternateSentinel())
811 const icon = "";
812 const anchorJS = new window.AnchorJS();
813 anchorJS.options = {
814 placement: 'right',
815 icon: icon
816 };
817 anchorJS.add('.anchored');
818 const isCodeAnnotation = (el) => {
819 for (const clz of el.classList) {
820 if (clz.startsWith('code-annotation-')) {
821 return true;
822 }
823 }
824 return false;
825 }
826 const onCopySuccess = function(e) {
827 // button target
828 const button = e.trigger;
829 // don't keep focus
830 button.blur();
831 // flash "checked"
832 button.classList.add('code-copy-button-checked');
833 var currentTitle = button.getAttribute("title");
834 button.setAttribute("title", "Copied!");
835 let tooltip;
836 if (window.bootstrap) {
837 button.setAttribute("data-bs-toggle", "tooltip");
838 button.setAttribute("data-bs-placement", "left");
839 button.setAttribute("data-bs-title", "Copied!");
840 tooltip = new bootstrap.Tooltip(button,
841 { trigger: "manual",
842 customClass: "code-copy-button-tooltip",
843 offset: [0, -8]});
844 tooltip.show();
845 }
846 setTimeout(function() {
847 if (tooltip) {
848 tooltip.hide();
849 button.removeAttribute("data-bs-title");
850 button.removeAttribute("data-bs-toggle");
851 button.removeAttribute("data-bs-placement");
852 }
853 button.setAttribute("title", currentTitle);
854 button.classList.remove('code-copy-button-checked');
855 }, 1000);
856 // clear code selection
857 e.clearSelection();
858 }
859 const getTextToCopy = function(trigger) {
860 const codeEl = trigger.previousElementSibling.cloneNode(true);
861 for (const childEl of codeEl.children) {
862 if (isCodeAnnotation(childEl)) {
863 childEl.remove();
864 }
865 }
866 return codeEl.innerText;
867 }
868 const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
869 text: getTextToCopy
870 });
871 clipboard.on('success', onCopySuccess);
872 if (window.document.getElementById('quarto-embedded-source-code-modal')) {
873 const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
874 text: getTextToCopy,
875 container: window.document.getElementById('quarto-embedded-source-code-modal')
876 });
877 clipboardModal.on('success', onCopySuccess);
878 }
879 var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
880 var mailtoRegex = new RegExp(/^mailto:/);
881 var filterRegex = new RegExp("https:\/\/github\.com\/your-org\/atdata");
882 var isInternal = (href) => {
883 return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
884 }
885 // Inspect non-navigation links and adorn them if external
886 var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)');
887 for (var i=0; i<links.length; i++) {
888 const link = links[i];
889 if (!isInternal(link.href)) {
890 // undo the damage that might have been done by quarto-nav.js in the case of
891 // links that we want to consider external
892 if (link.dataset.originalHref !== undefined) {
893 link.href = link.dataset.originalHref;
894 }
895 }
896 }
897 function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
898 const config = {
899 allowHTML: true,
900 maxWidth: 500,
901 delay: 100,
902 arrow: false,
903 appendTo: function(el) {
904 return el.parentElement;
905 },
906 interactive: true,
907 interactiveBorder: 10,
908 theme: 'quarto',
909 placement: 'bottom-start',
910 };
911 if (contentFn) {
912 config.content = contentFn;
913 }
914 if (onTriggerFn) {
915 config.onTrigger = onTriggerFn;
916 }
917 if (onUntriggerFn) {
918 config.onUntrigger = onUntriggerFn;
919 }
920 window.tippy(el, config);
921 }
922 const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
923 for (var i=0; i<noterefs.length; i++) {
924 const ref = noterefs[i];
925 tippyHover(ref, function() {
926 // use id or data attribute instead here
927 let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
928 try { href = new URL(href).hash; } catch {}
929 const id = href.replace(/^#\/?/, "");
930 const note = window.document.getElementById(id);
931 if (note) {
932 return note.innerHTML;
933 } else {
934 return "";
935 }
936 });
937 }
938 const xrefs = window.document.querySelectorAll('a.quarto-xref');
939 const processXRef = (id, note) => {
940 // Strip column container classes
941 const stripColumnClz = (el) => {
942 el.classList.remove("page-full", "page-columns");
943 if (el.children) {
944 for (const child of el.children) {
945 stripColumnClz(child);
946 }
947 }
948 }
949 stripColumnClz(note)
950 if (id === null || id.startsWith('sec-')) {
951 // Special case sections, only their first couple elements
952 const container = document.createElement("div");
953 if (note.children && note.children.length > 2) {
954 container.appendChild(note.children[0].cloneNode(true));
955 for (let i = 1; i < note.children.length; i++) {
956 const child = note.children[i];
957 if (child.tagName === "P" && child.innerText === "") {
958 continue;
959 } else {
960 container.appendChild(child.cloneNode(true));
961 break;
962 }
963 }
964 if (window.Quarto?.typesetMath) {
965 window.Quarto.typesetMath(container);
966 }
967 return container.innerHTML
968 } else {
969 if (window.Quarto?.typesetMath) {
970 window.Quarto.typesetMath(note);
971 }
972 return note.innerHTML;
973 }
974 } else {
975 // Remove any anchor links if they are present
976 const anchorLink = note.querySelector('a.anchorjs-link');
977 if (anchorLink) {
978 anchorLink.remove();
979 }
980 if (window.Quarto?.typesetMath) {
981 window.Quarto.typesetMath(note);
982 }
983 if (note.classList.contains("callout")) {
984 return note.outerHTML;
985 } else {
986 return note.innerHTML;
987 }
988 }
989 }
990 for (var i=0; i<xrefs.length; i++) {
991 const xref = xrefs[i];
992 tippyHover(xref, undefined, function(instance) {
993 instance.disable();
994 let url = xref.getAttribute('href');
995 let hash = undefined;
996 if (url.startsWith('#')) {
997 hash = url;
998 } else {
999 try { hash = new URL(url).hash; } catch {}
1000 }
1001 if (hash) {
1002 const id = hash.replace(/^#\/?/, "");
1003 const note = window.document.getElementById(id);
1004 if (note !== null) {
1005 try {
1006 const html = processXRef(id, note.cloneNode(true));
1007 instance.setContent(html);
1008 } finally {
1009 instance.enable();
1010 instance.show();
1011 }
1012 } else {
1013 // See if we can fetch this
1014 fetch(url.split('#')[0])
1015 .then(res => res.text())
1016 .then(html => {
1017 const parser = new DOMParser();
1018 const htmlDoc = parser.parseFromString(html, "text/html");
1019 const note = htmlDoc.getElementById(id);
1020 if (note !== null) {
1021 const html = processXRef(id, note);
1022 instance.setContent(html);
1023 }
1024 }).finally(() => {
1025 instance.enable();
1026 instance.show();
1027 });
1028 }
1029 } else {
1030 // See if we can fetch a full url (with no hash to target)
1031 // This is a special case and we should probably do some content thinning / targeting
1032 fetch(url)
1033 .then(res => res.text())
1034 .then(html => {
1035 const parser = new DOMParser();
1036 const htmlDoc = parser.parseFromString(html, "text/html");
1037 const note = htmlDoc.querySelector('main.content');
1038 if (note !== null) {
1039 // This should only happen for chapter cross references
1040 // (since there is no id in the URL)
1041 // remove the first header
1042 if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
1043 note.children[0].remove();
1044 }
1045 const html = processXRef(null, note);
1046 instance.setContent(html);
1047 }
1048 }).finally(() => {
1049 instance.enable();
1050 instance.show();
1051 });
1052 }
1053 }, function(instance) {
1054 });
1055 }
1056 let selectedAnnoteEl;
1057 const selectorForAnnotation = ( cell, annotation) => {
1058 let cellAttr = 'data-code-cell="' + cell + '"';
1059 let lineAttr = 'data-code-annotation="' + annotation + '"';
1060 const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
1061 return selector;
1062 }
1063 const selectCodeLines = (annoteEl) => {
1064 const doc = window.document;
1065 const targetCell = annoteEl.getAttribute("data-target-cell");
1066 const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
1067 const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
1068 const lines = annoteSpan.getAttribute("data-code-lines").split(",");
1069 const lineIds = lines.map((line) => {
1070 return targetCell + "-" + line;
1071 })
1072 let top = null;
1073 let height = null;
1074 let parent = null;
1075 if (lineIds.length > 0) {
1076 //compute the position of the single el (top and bottom and make a div)
1077 const el = window.document.getElementById(lineIds[0]);
1078 top = el.offsetTop;
1079 height = el.offsetHeight;
1080 parent = el.parentElement.parentElement;
1081 if (lineIds.length > 1) {
1082 const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
1083 const bottom = lastEl.offsetTop + lastEl.offsetHeight;
1084 height = bottom - top;
1085 }
1086 if (top !== null && height !== null && parent !== null) {
1087 // cook up a div (if necessary) and position it
1088 let div = window.document.getElementById("code-annotation-line-highlight");
1089 if (div === null) {
1090 div = window.document.createElement("div");
1091 div.setAttribute("id", "code-annotation-line-highlight");
1092 div.style.position = 'absolute';
1093 parent.appendChild(div);
1094 }
1095 div.style.top = top - 2 + "px";
1096 div.style.height = height + 4 + "px";
1097 div.style.left = 0;
1098 let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
1099 if (gutterDiv === null) {
1100 gutterDiv = window.document.createElement("div");
1101 gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
1102 gutterDiv.style.position = 'absolute';
1103 const codeCell = window.document.getElementById(targetCell);
1104 const gutter = codeCell.querySelector('.code-annotation-gutter');
1105 gutter.appendChild(gutterDiv);
1106 }
1107 gutterDiv.style.top = top - 2 + "px";
1108 gutterDiv.style.height = height + 4 + "px";
1109 }
1110 selectedAnnoteEl = annoteEl;
1111 }
1112 };
1113 const unselectCodeLines = () => {
1114 const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
1115 elementsIds.forEach((elId) => {
1116 const div = window.document.getElementById(elId);
1117 if (div) {
1118 div.remove();
1119 }
1120 });
1121 selectedAnnoteEl = undefined;
1122 };
1123 // Handle positioning of the toggle
1124 window.addEventListener(
1125 "resize",
1126 throttle(() => {
1127 elRect = undefined;
1128 if (selectedAnnoteEl) {
1129 selectCodeLines(selectedAnnoteEl);
1130 }
1131 }, 10)
1132 );
1133 function throttle(fn, ms) {
1134 let throttle = false;
1135 let timer;
1136 return (...args) => {
1137 if(!throttle) { // first call gets through
1138 fn.apply(this, args);
1139 throttle = true;
1140 } else { // all the others get throttled
1141 if(timer) clearTimeout(timer); // cancel #2
1142 timer = setTimeout(() => {
1143 fn.apply(this, args);
1144 timer = throttle = false;
1145 }, ms);
1146 }
1147 };
1148 }
1149 // Attach click handler to the DT
1150 const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
1151 for (const annoteDlNode of annoteDls) {
1152 annoteDlNode.addEventListener('click', (event) => {
1153 const clickedEl = event.target;
1154 if (clickedEl !== selectedAnnoteEl) {
1155 unselectCodeLines();
1156 const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
1157 if (activeEl) {
1158 activeEl.classList.remove('code-annotation-active');
1159 }
1160 selectCodeLines(clickedEl);
1161 clickedEl.classList.add('code-annotation-active');
1162 } else {
1163 // Unselect the line
1164 unselectCodeLines();
1165 clickedEl.classList.remove('code-annotation-active');
1166 }
1167 });
1168 }
1169 const findCites = (el) => {
1170 const parentEl = el.parentElement;
1171 if (parentEl) {
1172 const cites = parentEl.dataset.cites;
1173 if (cites) {
1174 return {
1175 el,
1176 cites: cites.split(' ')
1177 };
1178 } else {
1179 return findCites(el.parentElement)
1180 }
1181 } else {
1182 return undefined;
1183 }
1184 };
1185 var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
1186 for (var i=0; i<bibliorefs.length; i++) {
1187 const ref = bibliorefs[i];
1188 const citeInfo = findCites(ref);
1189 if (citeInfo) {
1190 tippyHover(citeInfo.el, function() {
1191 var popup = window.document.createElement('div');
1192 citeInfo.cites.forEach(function(cite) {
1193 var citeDiv = window.document.createElement('div');
1194 citeDiv.classList.add('hanging-indent');
1195 citeDiv.classList.add('csl-entry');
1196 var biblioDiv = window.document.getElementById('ref-' + cite);
1197 if (biblioDiv) {
1198 citeDiv.innerHTML = biblioDiv.innerHTML;
1199 }
1200 popup.appendChild(citeDiv);
1201 });
1202 return popup.innerHTML;
1203 });
1204 }
1205 }
1206 });
1207 </script>
1208</div> <!-- /content -->
1209<footer class="footer">
1210 <div class="nav-footer">
1211 <div class="nav-footer-left">
1212<p>Built with <a href="https://quarto.org/">Quarto</a></p>
1213</div>
1214 <div class="nav-footer-center">
1215
1216 <div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/your-org/atdata/edit/main/reference/promotion.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/your-org/atdata/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></div>
1217 <div class="nav-footer-right">
1218<p>MIT License</p>
1219</div>
1220 </div>
1221</footer>
1222
1223
1224
1225
1226</body></html>