Skip to content

Commit a62e677

Browse files
Feat/alias (#154)
* chore(ci): update ci for poetry install and update deps * fix(auth): fix issue where trailing / was compared to domain without and wouldn't use local creds because of it * feat(alias): add support for metadata aliases * fix(poetry): install script * fix(ci): fix poetry call * Apply automatic documentation changes * fix(ci): don't install deps twice * Apply automatic documentation changes * Update docs.yml * Apply automatic documentation changes Co-authored-by: Alexander VT <[email protected]>
1 parent bd7e642 commit a62e677

File tree

21 files changed

+1546
-141
lines changed

21 files changed

+1546
-141
lines changed

.github/workflows/docs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,14 @@ jobs:
2626
run: |
2727
pip install poetry
2828
poetry config virtualenvs.create false
29-
poetry install -vv
29+
poetry install -vv --no-interaction
30+
poetry show -vv
31+
3032
# install sphinx from PyPI (as of 03/16/21 python3-sphinx is broken)
3133
# sudo apt-get install python3-sphinx
3234
pip install sphinx
3335
pip uninstall -y asyncio
36+
pip list
3437
cd
3538
- name: Build docs
3639
run: |

.travis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ before_install:
1717
- which poetry
1818
- poetry --version
1919
install:
20-
- poetry install -vv
21-
- poetry show
20+
- poetry install -vv --no-interaction
21+
- poetry show -vv
2222
script:
2323
- poetry run pytest -vv ./tests
2424
before_deploy:
17.3 KB
Binary file not shown.
63.8 KB
Binary file not shown.
0 Bytes
Binary file not shown.
5 Bytes
Binary file not shown.

docs/_build/html/_modules/gen3/auth.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ <h1>Source code for gen3.auth</h1><div class="highlight"><pre>
254254
<span class="k">if</span> <span class="n">idp</span> <span class="ow">or</span> <span class="p">(</span>
255255
<span class="n">endpoint</span>
256256
<span class="ow">and</span> <span class="p">(</span>
257-
<span class="ow">not</span> <span class="n">endpoint</span>
257+
<span class="ow">not</span> <span class="n">endpoint</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span>
258258
<span class="o">==</span> <span class="n">endpoint_from_token</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_refresh_token</span><span class="p">[</span><span class="s2">&quot;api_key&quot;</span><span class="p">])</span>
259259
<span class="p">)</span>
260260
<span class="p">):</span>

docs/_build/html/_modules/gen3/metadata.html

Lines changed: 392 additions & 9 deletions
Large diffs are not rendered by default.

docs/_build/html/genindex.html

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,21 +72,29 @@ <h2 id="A">A</h2>
7272
<li><a href="tools/indexing.html#gen3.tools.indexing.index_manifest.ACLS">ACLS (in module gen3.tools.indexing.index_manifest)</a>
7373
</li>
7474
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.async_create">async_create() (gen3.metadata.Gen3Metadata method)</a>
75+
</li>
76+
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.async_create_aliases">async_create_aliases() (gen3.metadata.Gen3Metadata method)</a>
7577
</li>
7678
<li><a href="indexing.html#gen3.index.Gen3Index.async_create_record">async_create_record() (gen3.index.Gen3Index method)</a>
79+
</li>
80+
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.async_delete_alias">async_delete_alias() (gen3.metadata.Gen3Metadata method)</a>
81+
</li>
82+
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.async_delete_aliases">async_delete_aliases() (gen3.metadata.Gen3Metadata method)</a>
7783
</li>
7884
<li><a href="tools/indexing.html#gen3.tools.indexing.download_manifest.async_download_object_manifest">async_download_object_manifest() (in module gen3.tools.indexing.download_manifest)</a>
7985
</li>
8086
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.async_get">async_get() (gen3.metadata.Gen3Metadata method)</a>
87+
</li>
88+
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.async_get_aliases">async_get_aliases() (gen3.metadata.Gen3Metadata method)</a>
8189
</li>
8290
<li><a href="indexing.html#gen3.index.Gen3Index.async_get_record">async_get_record() (gen3.index.Gen3Index method)</a>
8391
</li>
8492
<li><a href="indexing.html#gen3.index.Gen3Index.async_get_records_from_checksum">async_get_records_from_checksum() (gen3.index.Gen3Index method)</a>
85-
</li>
86-
<li><a href="indexing.html#gen3.index.Gen3Index.async_get_records_on_page">async_get_records_on_page() (gen3.index.Gen3Index method)</a>
8793
</li>
8894
</ul></td>
8995
<td style="width: 33%; vertical-align: top;"><ul>
96+
<li><a href="indexing.html#gen3.index.Gen3Index.async_get_records_on_page">async_get_records_on_page() (gen3.index.Gen3Index method)</a>
97+
</li>
9098
<li><a href="indexing.html#gen3.index.Gen3Index.async_get_with_params">async_get_with_params() (gen3.index.Gen3Index method)</a>
9199
</li>
92100
<li><a href="tools/metadata.html#gen3.tools.metadata.ingest_manifest.async_ingest_metadata_manifest">async_ingest_metadata_manifest() (in module gen3.tools.metadata.ingest_manifest)</a>
@@ -98,6 +106,8 @@ <h2 id="A">A</h2>
98106
<li><a href="jobs.html#gen3.jobs.Gen3Jobs.async_run_job_and_wait">async_run_job_and_wait() (gen3.jobs.Gen3Jobs method)</a>
99107
</li>
100108
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.async_update">async_update() (gen3.metadata.Gen3Metadata method)</a>
109+
</li>
110+
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.async_update_aliases">async_update_aliases() (gen3.metadata.Gen3Metadata method)</a>
101111
</li>
102112
<li><a href="indexing.html#gen3.index.Gen3Index.async_update_record">async_update_record() (gen3.index.Gen3Index method)</a>
103113
</li>
@@ -132,6 +142,8 @@ <h2 id="C">C</h2>
132142
<li><a href="wss.html#gen3.wss.Gen3WsStorage.copy">copy() (gen3.wss.Gen3WsStorage method)</a>
133143
</li>
134144
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.create">create() (gen3.metadata.Gen3Metadata method)</a>
145+
</li>
146+
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.create_aliases">create_aliases() (gen3.metadata.Gen3Metadata method)</a>
135147
</li>
136148
<li><a href="indexing.html#gen3.index.Gen3Index.create_blank">create_blank() (gen3.index.Gen3Index method)</a>
137149
</li>
@@ -170,6 +182,10 @@ <h2 id="D">D</h2>
170182
<table style="width: 100%" class="indextable genindextable"><tr>
171183
<td style="width: 33%; vertical-align: top;"><ul>
172184
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.delete">delete() (gen3.metadata.Gen3Metadata method)</a>
185+
</li>
186+
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.delete_alias">delete_alias() (gen3.metadata.Gen3Metadata method)</a>
187+
</li>
188+
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.delete_aliases">delete_aliases() (gen3.metadata.Gen3Metadata method)</a>
173189
</li>
174190
<li><a href="tools/indexing.html#gen3.tools.indexing.index_manifest.delete_all_guids">delete_all_guids() (in module gen3.tools.indexing.index_manifest)</a>
175191
</li>
@@ -189,14 +205,14 @@ <h2 id="D">D</h2>
189205
</li>
190206
<li><a href="submission.html#gen3.submission.Gen3Submission.delete_project">delete_project() (gen3.submission.Gen3Submission method)</a>
191207
</li>
208+
</ul></td>
209+
<td style="width: 33%; vertical-align: top;"><ul>
192210
<li><a href="indexing.html#gen3.index.Gen3Index.delete_record">delete_record() (gen3.index.Gen3Index method)</a>
193211

194212
<ul>
195213
<li><a href="submission.html#gen3.submission.Gen3Submission.delete_record">(gen3.submission.Gen3Submission method)</a>
196214
</li>
197215
</ul></li>
198-
</ul></td>
199-
<td style="width: 33%; vertical-align: top;"><ul>
200216
<li><a href="submission.html#gen3.submission.Gen3Submission.delete_records">delete_records() (gen3.submission.Gen3Submission method)</a>
201217
</li>
202218
<li><a href="tools/drs_pull.html#gen3.tools.download.drs_download.Downloadable.download">download() (gen3.tools.download.drs_download.Downloadable method)</a>
@@ -330,15 +346,17 @@ <h2 id="G">G</h2>
330346
<li><a href="auth.html#gen3.auth.Gen3Auth.get_access_token">get_access_token() (gen3.auth.Gen3Auth method)</a>
331347
</li>
332348
<li><a href="auth.html#gen3.auth.Gen3Auth.get_access_token_from_wts">get_access_token_from_wts() (gen3.auth.Gen3Auth method)</a>
349+
</li>
350+
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.get_aliases">get_aliases() (gen3.metadata.Gen3Metadata method)</a>
333351
</li>
334352
<li><a href="indexing.html#gen3.index.Gen3Index.get_all_records">get_all_records() (gen3.index.Gen3Index method)</a>
335353
</li>
336354
<li><a href="submission.html#gen3.submission.Gen3Submission.get_dictionary_all">get_dictionary_all() (gen3.submission.Gen3Submission method)</a>
337-
</li>
338-
<li><a href="submission.html#gen3.submission.Gen3Submission.get_dictionary_node">get_dictionary_node() (gen3.submission.Gen3Submission method)</a>
339355
</li>
340356
</ul></td>
341357
<td style="width: 33%; vertical-align: top;"><ul>
358+
<li><a href="submission.html#gen3.submission.Gen3Submission.get_dictionary_node">get_dictionary_node() (gen3.submission.Gen3Submission method)</a>
359+
</li>
342360
<li><a href="tools/drs_pull.html#gen3.tools.download.drs_download.DownloadManager.get_fresh_token">get_fresh_token() (gen3.tools.download.drs_download.DownloadManager method)</a>
343361
</li>
344362
<li><a href="submission.html#gen3.submission.Gen3Submission.get_graphql_schema">get_graphql_schema() (gen3.submission.Gen3Submission method)</a>
@@ -591,6 +609,8 @@ <h2 id="U">U</h2>
591609
<table style="width: 100%" class="indextable genindextable"><tr>
592610
<td style="width: 33%; vertical-align: top;"><ul>
593611
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.update">update() (gen3.metadata.Gen3Metadata method)</a>
612+
</li>
613+
<li><a href="metadata.html#gen3.metadata.Gen3Metadata.update_aliases">update_aliases() (gen3.metadata.Gen3Metadata method)</a>
594614
</li>
595615
<li><a href="indexing.html#gen3.index.Gen3Index.update_blank">update_blank() (gen3.index.Gen3Index method)</a>
596616
</li>

0 commit comments

Comments
 (0)