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
10<title>promote_to_atmosphere – atdata</title>
11<style>
12code{white-space: pre-wrap;}
13span.smallcaps{font-variant: small-caps;}
14div.columns{display: flex; gap: min(4vw, 1.5em);}
15div.column{flex: auto; overflow-x: auto;}
16div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
17ul.task-list{list-style: none;}
18ul.task-list li input[type="checkbox"] {
19 width: 0.8em;
20 margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
21 vertical-align: middle;
22}
23/* CSS for syntax highlighting */
24html { -webkit-text-size-adjust: 100%; }
25pre > code.sourceCode { white-space: pre; position: relative; }
26pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
27pre > code.sourceCode > span:empty { height: 1.2em; }
28.sourceCode { overflow: visible; }
29code.sourceCode > span { color: inherit; text-decoration: inherit; }
30div.sourceCode { margin: 1em 0; }
31pre.sourceCode { margin: 0; }
32@media screen {
33div.sourceCode { overflow: auto; }
34}
35@media print {
36pre > code.sourceCode { white-space: pre-wrap; }
37pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
38}
39pre.numberSource code
40 { counter-reset: source-line 0; }
41pre.numberSource code > span
42 { position: relative; left: -4em; counter-increment: source-line; }
43pre.numberSource code > span > a:first-child::before
44 { content: counter(source-line);
45 position: relative; left: -1em; text-align: right; vertical-align: baseline;
46 border: none; display: inline-block;
47 -webkit-touch-callout: none; -webkit-user-select: none;
48 -khtml-user-select: none; -moz-user-select: none;
49 -ms-user-select: none; user-select: none;
50 padding: 0 4px; width: 4em;
51 }
52pre.numberSource { margin-left: 3em; padding-left: 4px; }
53div.sourceCode
54 { }
55@media screen {
56pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
57}
58</style>
59
60
61<script src="../site_libs/quarto-nav/quarto-nav.js"></script>
62<script src="../site_libs/quarto-nav/headroom.min.js"></script>
63<script src="../site_libs/clipboard/clipboard.min.js"></script>
64<script src="../site_libs/quarto-search/autocomplete.umd.js"></script>
65<script src="../site_libs/quarto-search/fuse.min.js"></script>
66<script src="../site_libs/quarto-search/quarto-search.js"></script>
67<meta name="quarto:offset" content="../">
68<script src="../site_libs/quarto-html/quarto.js" type="module"></script>
69<script src="../site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
70<script src="../site_libs/quarto-html/popper.min.js"></script>
71<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
72<script src="../site_libs/quarto-html/anchor.min.js"></script>
73<link href="../site_libs/quarto-html/tippy.css" rel="stylesheet">
74<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme" id="quarto-text-highlighting-styles">
75<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">
76<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme-extra" id="quarto-text-highlighting-styles">
77<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
78<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
79<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme" id="quarto-bootstrap" data-mode="light">
80<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">
81<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">
82<script id="quarto-search-options" type="application/json">{
83 "location": "navbar",
84 "copy-button": false,
85 "collapse-after": 3,
86 "panel-placement": "end",
87 "type": "overlay",
88 "limit": 50,
89 "keyboard-shortcut": [
90 "f",
91 "/",
92 "s"
93 ],
94 "show-item-context": false,
95 "language": {
96 "search-no-results-text": "No results",
97 "search-matching-documents-text": "matching documents",
98 "search-copy-link-title": "Copy link to search",
99 "search-hide-matches-text": "Hide additional matches",
100 "search-more-match-text": "more match in this document",
101 "search-more-matches-text": "more matches in this document",
102 "search-clear-button-title": "Clear",
103 "search-text-placeholder": "",
104 "search-detached-cancel-button-title": "Cancel",
105 "search-submit-button-title": "Submit",
106 "search-label": "Search"
107 }
108}</script>
109
110
111<link rel="stylesheet" href="../assets/styles.css">
112</head>
113
114<body class="nav-fixed quarto-light"><script id="quarto-html-before-body" type="application/javascript">
115 const toggleBodyColorMode = (bsSheetEl) => {
116 const mode = bsSheetEl.getAttribute("data-mode");
117 const bodyEl = window.document.querySelector("body");
118 if (mode === "dark") {
119 bodyEl.classList.add("quarto-dark");
120 bodyEl.classList.remove("quarto-light");
121 } else {
122 bodyEl.classList.add("quarto-light");
123 bodyEl.classList.remove("quarto-dark");
124 }
125 }
126 const toggleBodyColorPrimary = () => {
127 const bsSheetEl = window.document.querySelector("link#quarto-bootstrap:not([rel=disabled-stylesheet])");
128 if (bsSheetEl) {
129 toggleBodyColorMode(bsSheetEl);
130 }
131 }
132 const setColorSchemeToggle = (alternate) => {
133 const toggles = window.document.querySelectorAll('.quarto-color-scheme-toggle');
134 for (let i=0; i < toggles.length; i++) {
135 const toggle = toggles[i];
136 if (toggle) {
137 if (alternate) {
138 toggle.classList.add("alternate");
139 } else {
140 toggle.classList.remove("alternate");
141 }
142 }
143 }
144 };
145 const toggleColorMode = (alternate) => {
146 // Switch the stylesheets
147 const primaryStylesheets = window.document.querySelectorAll('link.quarto-color-scheme:not(.quarto-color-alternate)');
148 const alternateStylesheets = window.document.querySelectorAll('link.quarto-color-scheme.quarto-color-alternate');
149 manageTransitions('#quarto-margin-sidebar .nav-link', false);
150 if (alternate) {
151 // note: dark is layered on light, we don't disable primary!
152 enableStylesheet(alternateStylesheets);
153 for (const sheetNode of alternateStylesheets) {
154 if (sheetNode.id === "quarto-bootstrap") {
155 toggleBodyColorMode(sheetNode);
156 }
157 }
158 } else {
159 disableStylesheet(alternateStylesheets);
160 enableStylesheet(primaryStylesheets)
161 toggleBodyColorPrimary();
162 }
163 manageTransitions('#quarto-margin-sidebar .nav-link', true);
164 // Switch the toggles
165 setColorSchemeToggle(alternate)
166 // Hack to workaround the fact that safari doesn't
167 // properly recolor the scrollbar when toggling (#1455)
168 if (navigator.userAgent.indexOf('Safari') > 0 && navigator.userAgent.indexOf('Chrome') == -1) {
169 manageTransitions("body", false);
170 window.scrollTo(0, 1);
171 setTimeout(() => {
172 window.scrollTo(0, 0);
173 manageTransitions("body", true);
174 }, 40);
175 }
176 }
177 const disableStylesheet = (stylesheets) => {
178 for (let i=0; i < stylesheets.length; i++) {
179 const stylesheet = stylesheets[i];
180 stylesheet.rel = 'disabled-stylesheet';
181 }
182 }
183 const enableStylesheet = (stylesheets) => {
184 for (let i=0; i < stylesheets.length; i++) {
185 const stylesheet = stylesheets[i];
186 if(stylesheet.rel !== 'stylesheet') { // for Chrome, which will still FOUC without this check
187 stylesheet.rel = 'stylesheet';
188 }
189 }
190 }
191 const manageTransitions = (selector, allowTransitions) => {
192 const els = window.document.querySelectorAll(selector);
193 for (let i=0; i < els.length; i++) {
194 const el = els[i];
195 if (allowTransitions) {
196 el.classList.remove('notransition');
197 } else {
198 el.classList.add('notransition');
199 }
200 }
201 }
202 const isFileUrl = () => {
203 return window.location.protocol === 'file:';
204 }
205 const hasAlternateSentinel = () => {
206 let styleSentinel = getColorSchemeSentinel();
207 if (styleSentinel !== null) {
208 return styleSentinel === "alternate";
209 } else {
210 return false;
211 }
212 }
213 const setStyleSentinel = (alternate) => {
214 const value = alternate ? "alternate" : "default";
215 if (!isFileUrl()) {
216 window.localStorage.setItem("quarto-color-scheme", value);
217 } else {
218 localAlternateSentinel = value;
219 }
220 }
221 const getColorSchemeSentinel = () => {
222 if (!isFileUrl()) {
223 const storageValue = window.localStorage.getItem("quarto-color-scheme");
224 return storageValue != null ? storageValue : localAlternateSentinel;
225 } else {
226 return localAlternateSentinel;
227 }
228 }
229 const toggleGiscusIfUsed = (isAlternate, darkModeDefault) => {
230 const baseTheme = document.querySelector('#giscus-base-theme')?.value ?? 'light';
231 const alternateTheme = document.querySelector('#giscus-alt-theme')?.value ?? 'dark';
232 let newTheme = '';
233 if(authorPrefersDark) {
234 newTheme = isAlternate ? baseTheme : alternateTheme;
235 } else {
236 newTheme = isAlternate ? alternateTheme : baseTheme;
237 }
238 const changeGiscusTheme = () => {
239 // From: https://github.com/giscus/giscus/issues/336
240 const sendMessage = (message) => {
241 const iframe = document.querySelector('iframe.giscus-frame');
242 if (!iframe) return;
243 iframe.contentWindow.postMessage({ giscus: message }, 'https://giscus.app');
244 }
245 sendMessage({
246 setConfig: {
247 theme: newTheme
248 }
249 });
250 }
251 const isGiscussLoaded = window.document.querySelector('iframe.giscus-frame') !== null;
252 if (isGiscussLoaded) {
253 changeGiscusTheme();
254 }
255 };
256 const authorPrefersDark = false;
257 const darkModeDefault = authorPrefersDark;
258 document.querySelector('link#quarto-text-highlighting-styles.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
259 document.querySelector('link#quarto-bootstrap.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
260 let localAlternateSentinel = darkModeDefault ? 'alternate' : 'default';
261 // Dark / light mode switch
262 window.quartoToggleColorScheme = () => {
263 // Read the current dark / light value
264 let toAlternate = !hasAlternateSentinel();
265 toggleColorMode(toAlternate);
266 setStyleSentinel(toAlternate);
267 toggleGiscusIfUsed(toAlternate, darkModeDefault);
268 window.dispatchEvent(new Event('resize'));
269 };
270 // Switch to dark mode if need be
271 if (hasAlternateSentinel()) {
272 toggleColorMode(true);
273 } else {
274 toggleColorMode(false);
275 }
276 </script>
277
278<div id="quarto-search-results"></div>
279 <header id="quarto-header" class="headroom fixed-top">
280 <nav class="navbar navbar-expand-lg " data-bs-theme="dark">
281 <div class="navbar-container container-fluid">
282 <div class="navbar-brand-container mx-auto">
283 <a class="navbar-brand" href="../index.html">
284 <span class="navbar-title">atdata</span>
285 </a>
286 </div>
287 <div id="quarto-search" class="" title="Search"></div>
288 <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(); }">
289 <span class="navbar-toggler-icon"></span>
290</button>
291 <div class="collapse navbar-collapse" id="navbarCollapse">
292 <ul class="navbar-nav navbar-nav-scroll me-auto">
293 <li class="nav-item">
294 <a class="nav-link" href="../index.html">
295<span class="menu-text">Guide</span></a>
296 </li>
297 <li class="nav-item dropdown ">
298 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-tutorials" role="link" data-bs-toggle="dropdown" aria-expanded="false">
299 <span class="menu-text">Tutorials</span>
300 </a>
301 <ul class="dropdown-menu" aria-labelledby="nav-menu-tutorials">
302 <li>
303 <a class="dropdown-item" href="../tutorials/quickstart.html">
304 <span class="dropdown-text">Quick Start</span></a>
305 </li>
306 <li>
307 <a class="dropdown-item" href="../tutorials/local-workflow.html">
308 <span class="dropdown-text">Local Workflow</span></a>
309 </li>
310 <li>
311 <a class="dropdown-item" href="../tutorials/atmosphere.html">
312 <span class="dropdown-text">Atmosphere Publishing</span></a>
313 </li>
314 <li>
315 <a class="dropdown-item" href="../tutorials/promotion.html">
316 <span class="dropdown-text">Promotion Workflow</span></a>
317 </li>
318 </ul>
319 </li>
320 <li class="nav-item dropdown ">
321 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-reference" role="link" data-bs-toggle="dropdown" aria-expanded="false">
322 <span class="menu-text">Reference</span>
323 </a>
324 <ul class="dropdown-menu" aria-labelledby="nav-menu-reference">
325 <li>
326 <a class="dropdown-item" href="../reference/architecture.html">
327 <span class="dropdown-text">Architecture Overview</span></a>
328 </li>
329 <li>
330 <a class="dropdown-item" href="../reference/packable-samples.html">
331 <span class="dropdown-text">Packable Samples</span></a>
332 </li>
333 <li>
334 <a class="dropdown-item" href="../reference/datasets.html">
335 <span class="dropdown-text">Datasets</span></a>
336 </li>
337 <li>
338 <a class="dropdown-item" href="../reference/lenses.html">
339 <span class="dropdown-text">Lenses</span></a>
340 </li>
341 <li>
342 <a class="dropdown-item" href="../reference/local-storage.html">
343 <span class="dropdown-text">Local Storage</span></a>
344 </li>
345 <li>
346 <a class="dropdown-item" href="../reference/atmosphere.html">
347 <span class="dropdown-text">Atmosphere</span></a>
348 </li>
349 <li>
350 <a class="dropdown-item" href="../reference/promotion.html">
351 <span class="dropdown-text">Promotion</span></a>
352 </li>
353 <li>
354 <a class="dropdown-item" href="../reference/load-dataset.html">
355 <span class="dropdown-text">load_dataset API</span></a>
356 </li>
357 <li>
358 <a class="dropdown-item" href="../reference/protocols.html">
359 <span class="dropdown-text">Protocols</span></a>
360 </li>
361 <li>
362 <a class="dropdown-item" href="../reference/uri-spec.html">
363 <span class="dropdown-text">URI Specification</span></a>
364 </li>
365 <li>
366 <a class="dropdown-item" href="../reference/troubleshooting.html">
367 <span class="dropdown-text">Troubleshooting & FAQ</span></a>
368 </li>
369 <li>
370 <a class="dropdown-item" href="../reference/deployment.html">
371 <span class="dropdown-text">Deployment Guide</span></a>
372 </li>
373 </ul>
374 </li>
375 <li class="nav-item">
376 <a class="nav-link" href="../api/index.html">
377<span class="menu-text">API</span></a>
378 </li>
379</ul>
380 <ul class="navbar-nav navbar-nav-scroll ms-auto">
381 <li class="nav-item compact">
382 <a class="nav-link" href="https://github.com/your-org/atdata"> <i class="bi bi-github" role="img">
383</i>
384<span class="menu-text"></span></a>
385 </li>
386</ul>
387 </div> <!-- /navcollapse -->
388 <div class="quarto-navbar-tools">
389 <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>
390</div>
391 </div> <!-- /container-fluid -->
392 </nav>
393</header>
394<!-- content -->
395<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
396<!-- sidebar -->
397<!-- margin-sidebar -->
398 <div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
399 <nav id="TOC" role="doc-toc" class="toc-active">
400 <h2 id="toc-title">On this page</h2>
401
402 <ul>
403 <li><a href="#atdata.promote.promote_to_atmosphere" id="toc-atdata.promote.promote_to_atmosphere" class="nav-link active" data-scroll-target="#atdata.promote.promote_to_atmosphere">promote_to_atmosphere</a>
404 <ul class="collapse">
405 <li><a href="#parameters" id="toc-parameters" class="nav-link" data-scroll-target="#parameters">Parameters</a></li>
406 <li><a href="#returns" id="toc-returns" class="nav-link" data-scroll-target="#returns">Returns</a></li>
407 <li><a href="#raises" id="toc-raises" class="nav-link" data-scroll-target="#raises">Raises</a></li>
408 <li><a href="#examples" id="toc-examples" class="nav-link" data-scroll-target="#examples">Examples</a></li>
409 </ul></li>
410 </ul>
411<div class="toc-actions"><ul><li><a href="https://github.com/your-org/atdata/edit/main/api/promote_to_atmosphere.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>
412 </div>
413<!-- main -->
414<main class="content" id="quarto-document-content"><header id="title-block-header" class="quarto-title-block"></header>
415
416
417
418
419
420<section id="atdata.promote.promote_to_atmosphere" class="level1">
421<h1>promote_to_atmosphere</h1>
422<div class="sourceCode" 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>promote.promote_to_atmosphere(</span>
423<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> local_entry,</span>
424<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a> local_index,</span>
425<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> atmosphere_client,</span>
426<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a> <span class="op">*</span>,</span>
427<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a> data_store<span class="op">=</span><span class="va">None</span>,</span>
428<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a> name<span class="op">=</span><span class="va">None</span>,</span>
429<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a> description<span class="op">=</span><span class="va">None</span>,</span>
430<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a> tags<span class="op">=</span><span class="va">None</span>,</span>
431<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a> license<span class="op">=</span><span class="va">None</span>,</span>
432<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
433<p>Promote a local dataset to the atmosphere network.</p>
434<p>This function takes a locally-indexed dataset and publishes it to ATProto, making it discoverable on the federated atmosphere network.</p>
435<section id="parameters" class="level2 doc-section doc-section-parameters">
436<h2 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters">Parameters</h2>
437<table class="caption-top table">
438<thead>
439<tr class="header">
440<th>Name</th>
441<th>Type</th>
442<th>Description</th>
443<th>Default</th>
444</tr>
445</thead>
446<tbody>
447<tr class="odd">
448<td>local_entry</td>
449<td><a href="`atdata.local.LocalDatasetEntry`">LocalDatasetEntry</a></td>
450<td>The LocalDatasetEntry to promote.</td>
451<td><em>required</em></td>
452</tr>
453<tr class="even">
454<td>local_index</td>
455<td><a href="`atdata.local.Index`">LocalIndex</a></td>
456<td>Local index containing the schema for this entry.</td>
457<td><em>required</em></td>
458</tr>
459<tr class="odd">
460<td>atmosphere_client</td>
461<td><a href="`atdata.atmosphere.AtmosphereClient`">AtmosphereClient</a></td>
462<td>Authenticated AtmosphereClient.</td>
463<td><em>required</em></td>
464</tr>
465<tr class="even">
466<td>data_store</td>
467<td><a href="`atdata._protocols.AbstractDataStore`">AbstractDataStore</a> | None</td>
468<td>Optional data store for copying data to new location. If None, the existing data_urls are used as-is.</td>
469<td><code>None</code></td>
470</tr>
471<tr class="odd">
472<td>name</td>
473<td><a href="`str`">str</a> | None</td>
474<td>Override name for the atmosphere record. Defaults to local name.</td>
475<td><code>None</code></td>
476</tr>
477<tr class="even">
478<td>description</td>
479<td><a href="`str`">str</a> | None</td>
480<td>Optional description for the dataset.</td>
481<td><code>None</code></td>
482</tr>
483<tr class="odd">
484<td>tags</td>
485<td><a href="`list`">list</a>[<a href="`str`">str</a>] | None</td>
486<td>Optional tags for discovery.</td>
487<td><code>None</code></td>
488</tr>
489<tr class="even">
490<td>license</td>
491<td><a href="`str`">str</a> | None</td>
492<td>Optional license identifier.</td>
493<td><code>None</code></td>
494</tr>
495</tbody>
496</table>
497</section>
498<section id="returns" class="level2 doc-section doc-section-returns">
499<h2 class="doc-section doc-section-returns anchored" data-anchor-id="returns">Returns</h2>
500<table class="caption-top table">
501<thead>
502<tr class="header">
503<th>Name</th>
504<th>Type</th>
505<th>Description</th>
506</tr>
507</thead>
508<tbody>
509<tr class="odd">
510<td></td>
511<td><a href="`str`">str</a></td>
512<td>AT URI of the created atmosphere dataset record.</td>
513</tr>
514</tbody>
515</table>
516</section>
517<section id="raises" class="level2 doc-section doc-section-raises">
518<h2 class="doc-section doc-section-raises anchored" data-anchor-id="raises">Raises</h2>
519<table class="caption-top table">
520<thead>
521<tr class="header">
522<th>Name</th>
523<th>Type</th>
524<th>Description</th>
525</tr>
526</thead>
527<tbody>
528<tr class="odd">
529<td></td>
530<td><a href="`KeyError`">KeyError</a></td>
531<td>If schema not found in local index.</td>
532</tr>
533<tr class="even">
534<td></td>
535<td><a href="`ValueError`">ValueError</a></td>
536<td>If local entry has no data URLs.</td>
537</tr>
538</tbody>
539</table>
540</section>
541<section id="examples" class="level2 doc-section doc-section-examples">
542<h2 class="doc-section doc-section-examples anchored" data-anchor-id="examples">Examples</h2>
543<div class="sourceCode" 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><span class="op">>>></span> entry <span class="op">=</span> local_index.get_dataset(<span class="st">"mnist-train"</span>)</span>
544<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> uri <span class="op">=</span> promote_to_atmosphere(entry, local_index, client)</span>
545<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> <span class="bu">print</span>(uri)</span>
546<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a>at:<span class="op">//</span>did:plc:abc123<span class="op">/</span>ac.foundation.dataset.datasetIndex<span class="op">/</span>...</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
547
548
549</section>
550</section>
551
552</main> <!-- /main -->
553<script id="quarto-html-after-body" type="application/javascript">
554 window.document.addEventListener("DOMContentLoaded", function (event) {
555 // Ensure there is a toggle, if there isn't float one in the top right
556 if (window.document.querySelector('.quarto-color-scheme-toggle') === null) {
557 const a = window.document.createElement('a');
558 a.classList.add('top-right');
559 a.classList.add('quarto-color-scheme-toggle');
560 a.href = "";
561 a.onclick = function() { try { window.quartoToggleColorScheme(); } catch {} return false; };
562 const i = window.document.createElement("i");
563 i.classList.add('bi');
564 a.appendChild(i);
565 window.document.body.appendChild(a);
566 }
567 setColorSchemeToggle(hasAlternateSentinel())
568 const icon = "";
569 const anchorJS = new window.AnchorJS();
570 anchorJS.options = {
571 placement: 'right',
572 icon: icon
573 };
574 anchorJS.add('.anchored');
575 const isCodeAnnotation = (el) => {
576 for (const clz of el.classList) {
577 if (clz.startsWith('code-annotation-')) {
578 return true;
579 }
580 }
581 return false;
582 }
583 const onCopySuccess = function(e) {
584 // button target
585 const button = e.trigger;
586 // don't keep focus
587 button.blur();
588 // flash "checked"
589 button.classList.add('code-copy-button-checked');
590 var currentTitle = button.getAttribute("title");
591 button.setAttribute("title", "Copied!");
592 let tooltip;
593 if (window.bootstrap) {
594 button.setAttribute("data-bs-toggle", "tooltip");
595 button.setAttribute("data-bs-placement", "left");
596 button.setAttribute("data-bs-title", "Copied!");
597 tooltip = new bootstrap.Tooltip(button,
598 { trigger: "manual",
599 customClass: "code-copy-button-tooltip",
600 offset: [0, -8]});
601 tooltip.show();
602 }
603 setTimeout(function() {
604 if (tooltip) {
605 tooltip.hide();
606 button.removeAttribute("data-bs-title");
607 button.removeAttribute("data-bs-toggle");
608 button.removeAttribute("data-bs-placement");
609 }
610 button.setAttribute("title", currentTitle);
611 button.classList.remove('code-copy-button-checked');
612 }, 1000);
613 // clear code selection
614 e.clearSelection();
615 }
616 const getTextToCopy = function(trigger) {
617 const codeEl = trigger.previousElementSibling.cloneNode(true);
618 for (const childEl of codeEl.children) {
619 if (isCodeAnnotation(childEl)) {
620 childEl.remove();
621 }
622 }
623 return codeEl.innerText;
624 }
625 const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
626 text: getTextToCopy
627 });
628 clipboard.on('success', onCopySuccess);
629 if (window.document.getElementById('quarto-embedded-source-code-modal')) {
630 const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
631 text: getTextToCopy,
632 container: window.document.getElementById('quarto-embedded-source-code-modal')
633 });
634 clipboardModal.on('success', onCopySuccess);
635 }
636 var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
637 var mailtoRegex = new RegExp(/^mailto:/);
638 var filterRegex = new RegExp("https:\/\/github\.com\/your-org\/atdata");
639 var isInternal = (href) => {
640 return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
641 }
642 // Inspect non-navigation links and adorn them if external
643 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)');
644 for (var i=0; i<links.length; i++) {
645 const link = links[i];
646 if (!isInternal(link.href)) {
647 // undo the damage that might have been done by quarto-nav.js in the case of
648 // links that we want to consider external
649 if (link.dataset.originalHref !== undefined) {
650 link.href = link.dataset.originalHref;
651 }
652 }
653 }
654 function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
655 const config = {
656 allowHTML: true,
657 maxWidth: 500,
658 delay: 100,
659 arrow: false,
660 appendTo: function(el) {
661 return el.parentElement;
662 },
663 interactive: true,
664 interactiveBorder: 10,
665 theme: 'quarto',
666 placement: 'bottom-start',
667 };
668 if (contentFn) {
669 config.content = contentFn;
670 }
671 if (onTriggerFn) {
672 config.onTrigger = onTriggerFn;
673 }
674 if (onUntriggerFn) {
675 config.onUntrigger = onUntriggerFn;
676 }
677 window.tippy(el, config);
678 }
679 const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
680 for (var i=0; i<noterefs.length; i++) {
681 const ref = noterefs[i];
682 tippyHover(ref, function() {
683 // use id or data attribute instead here
684 let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
685 try { href = new URL(href).hash; } catch {}
686 const id = href.replace(/^#\/?/, "");
687 const note = window.document.getElementById(id);
688 if (note) {
689 return note.innerHTML;
690 } else {
691 return "";
692 }
693 });
694 }
695 const xrefs = window.document.querySelectorAll('a.quarto-xref');
696 const processXRef = (id, note) => {
697 // Strip column container classes
698 const stripColumnClz = (el) => {
699 el.classList.remove("page-full", "page-columns");
700 if (el.children) {
701 for (const child of el.children) {
702 stripColumnClz(child);
703 }
704 }
705 }
706 stripColumnClz(note)
707 if (id === null || id.startsWith('sec-')) {
708 // Special case sections, only their first couple elements
709 const container = document.createElement("div");
710 if (note.children && note.children.length > 2) {
711 container.appendChild(note.children[0].cloneNode(true));
712 for (let i = 1; i < note.children.length; i++) {
713 const child = note.children[i];
714 if (child.tagName === "P" && child.innerText === "") {
715 continue;
716 } else {
717 container.appendChild(child.cloneNode(true));
718 break;
719 }
720 }
721 if (window.Quarto?.typesetMath) {
722 window.Quarto.typesetMath(container);
723 }
724 return container.innerHTML
725 } else {
726 if (window.Quarto?.typesetMath) {
727 window.Quarto.typesetMath(note);
728 }
729 return note.innerHTML;
730 }
731 } else {
732 // Remove any anchor links if they are present
733 const anchorLink = note.querySelector('a.anchorjs-link');
734 if (anchorLink) {
735 anchorLink.remove();
736 }
737 if (window.Quarto?.typesetMath) {
738 window.Quarto.typesetMath(note);
739 }
740 if (note.classList.contains("callout")) {
741 return note.outerHTML;
742 } else {
743 return note.innerHTML;
744 }
745 }
746 }
747 for (var i=0; i<xrefs.length; i++) {
748 const xref = xrefs[i];
749 tippyHover(xref, undefined, function(instance) {
750 instance.disable();
751 let url = xref.getAttribute('href');
752 let hash = undefined;
753 if (url.startsWith('#')) {
754 hash = url;
755 } else {
756 try { hash = new URL(url).hash; } catch {}
757 }
758 if (hash) {
759 const id = hash.replace(/^#\/?/, "");
760 const note = window.document.getElementById(id);
761 if (note !== null) {
762 try {
763 const html = processXRef(id, note.cloneNode(true));
764 instance.setContent(html);
765 } finally {
766 instance.enable();
767 instance.show();
768 }
769 } else {
770 // See if we can fetch this
771 fetch(url.split('#')[0])
772 .then(res => res.text())
773 .then(html => {
774 const parser = new DOMParser();
775 const htmlDoc = parser.parseFromString(html, "text/html");
776 const note = htmlDoc.getElementById(id);
777 if (note !== null) {
778 const html = processXRef(id, note);
779 instance.setContent(html);
780 }
781 }).finally(() => {
782 instance.enable();
783 instance.show();
784 });
785 }
786 } else {
787 // See if we can fetch a full url (with no hash to target)
788 // This is a special case and we should probably do some content thinning / targeting
789 fetch(url)
790 .then(res => res.text())
791 .then(html => {
792 const parser = new DOMParser();
793 const htmlDoc = parser.parseFromString(html, "text/html");
794 const note = htmlDoc.querySelector('main.content');
795 if (note !== null) {
796 // This should only happen for chapter cross references
797 // (since there is no id in the URL)
798 // remove the first header
799 if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
800 note.children[0].remove();
801 }
802 const html = processXRef(null, note);
803 instance.setContent(html);
804 }
805 }).finally(() => {
806 instance.enable();
807 instance.show();
808 });
809 }
810 }, function(instance) {
811 });
812 }
813 let selectedAnnoteEl;
814 const selectorForAnnotation = ( cell, annotation) => {
815 let cellAttr = 'data-code-cell="' + cell + '"';
816 let lineAttr = 'data-code-annotation="' + annotation + '"';
817 const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
818 return selector;
819 }
820 const selectCodeLines = (annoteEl) => {
821 const doc = window.document;
822 const targetCell = annoteEl.getAttribute("data-target-cell");
823 const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
824 const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
825 const lines = annoteSpan.getAttribute("data-code-lines").split(",");
826 const lineIds = lines.map((line) => {
827 return targetCell + "-" + line;
828 })
829 let top = null;
830 let height = null;
831 let parent = null;
832 if (lineIds.length > 0) {
833 //compute the position of the single el (top and bottom and make a div)
834 const el = window.document.getElementById(lineIds[0]);
835 top = el.offsetTop;
836 height = el.offsetHeight;
837 parent = el.parentElement.parentElement;
838 if (lineIds.length > 1) {
839 const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
840 const bottom = lastEl.offsetTop + lastEl.offsetHeight;
841 height = bottom - top;
842 }
843 if (top !== null && height !== null && parent !== null) {
844 // cook up a div (if necessary) and position it
845 let div = window.document.getElementById("code-annotation-line-highlight");
846 if (div === null) {
847 div = window.document.createElement("div");
848 div.setAttribute("id", "code-annotation-line-highlight");
849 div.style.position = 'absolute';
850 parent.appendChild(div);
851 }
852 div.style.top = top - 2 + "px";
853 div.style.height = height + 4 + "px";
854 div.style.left = 0;
855 let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
856 if (gutterDiv === null) {
857 gutterDiv = window.document.createElement("div");
858 gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
859 gutterDiv.style.position = 'absolute';
860 const codeCell = window.document.getElementById(targetCell);
861 const gutter = codeCell.querySelector('.code-annotation-gutter');
862 gutter.appendChild(gutterDiv);
863 }
864 gutterDiv.style.top = top - 2 + "px";
865 gutterDiv.style.height = height + 4 + "px";
866 }
867 selectedAnnoteEl = annoteEl;
868 }
869 };
870 const unselectCodeLines = () => {
871 const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
872 elementsIds.forEach((elId) => {
873 const div = window.document.getElementById(elId);
874 if (div) {
875 div.remove();
876 }
877 });
878 selectedAnnoteEl = undefined;
879 };
880 // Handle positioning of the toggle
881 window.addEventListener(
882 "resize",
883 throttle(() => {
884 elRect = undefined;
885 if (selectedAnnoteEl) {
886 selectCodeLines(selectedAnnoteEl);
887 }
888 }, 10)
889 );
890 function throttle(fn, ms) {
891 let throttle = false;
892 let timer;
893 return (...args) => {
894 if(!throttle) { // first call gets through
895 fn.apply(this, args);
896 throttle = true;
897 } else { // all the others get throttled
898 if(timer) clearTimeout(timer); // cancel #2
899 timer = setTimeout(() => {
900 fn.apply(this, args);
901 timer = throttle = false;
902 }, ms);
903 }
904 };
905 }
906 // Attach click handler to the DT
907 const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
908 for (const annoteDlNode of annoteDls) {
909 annoteDlNode.addEventListener('click', (event) => {
910 const clickedEl = event.target;
911 if (clickedEl !== selectedAnnoteEl) {
912 unselectCodeLines();
913 const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
914 if (activeEl) {
915 activeEl.classList.remove('code-annotation-active');
916 }
917 selectCodeLines(clickedEl);
918 clickedEl.classList.add('code-annotation-active');
919 } else {
920 // Unselect the line
921 unselectCodeLines();
922 clickedEl.classList.remove('code-annotation-active');
923 }
924 });
925 }
926 const findCites = (el) => {
927 const parentEl = el.parentElement;
928 if (parentEl) {
929 const cites = parentEl.dataset.cites;
930 if (cites) {
931 return {
932 el,
933 cites: cites.split(' ')
934 };
935 } else {
936 return findCites(el.parentElement)
937 }
938 } else {
939 return undefined;
940 }
941 };
942 var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
943 for (var i=0; i<bibliorefs.length; i++) {
944 const ref = bibliorefs[i];
945 const citeInfo = findCites(ref);
946 if (citeInfo) {
947 tippyHover(citeInfo.el, function() {
948 var popup = window.document.createElement('div');
949 citeInfo.cites.forEach(function(cite) {
950 var citeDiv = window.document.createElement('div');
951 citeDiv.classList.add('hanging-indent');
952 citeDiv.classList.add('csl-entry');
953 var biblioDiv = window.document.getElementById('ref-' + cite);
954 if (biblioDiv) {
955 citeDiv.innerHTML = biblioDiv.innerHTML;
956 }
957 popup.appendChild(citeDiv);
958 });
959 return popup.innerHTML;
960 });
961 }
962 }
963 });
964 </script>
965</div> <!-- /content -->
966<footer class="footer">
967 <div class="nav-footer">
968 <div class="nav-footer-left">
969<p>Built with <a href="https://quarto.org/">Quarto</a></p>
970</div>
971 <div class="nav-footer-center">
972
973 <div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/your-org/atdata/edit/main/api/promote_to_atmosphere.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>
974 <div class="nav-footer-right">
975<p>MIT License</p>
976</div>
977 </div>
978</footer>
979
980
981
982
983</body></html>