Skip to content

Commit 7a5277e

Browse files
Updated docs
1 parent 78204b7 commit 7a5277e

File tree

3 files changed

+127
-0
lines changed

3 files changed

+127
-0
lines changed

docs/things.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ <h1 class="modulename">
7171
<span class="n">tasks</span><span class="p">,</span>
7272
<span class="n">today</span><span class="p">,</span>
7373
<span class="n">todos</span><span class="p">,</span>
74+
<span class="n">token</span><span class="p">,</span>
7475
<span class="n">upcoming</span><span class="p">,</span>
7576
<span class="p">)</span>
7677
<span class="kn">from</span> <span class="nn">things.database</span> <span class="kn">import</span> <span class="n">Database</span> <span class="c1"># noqa</span>

docs/things/api.html

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,9 @@ <h2>API Documentation</h2>
7878
<li>
7979
<a class="function" href="#deadlines">deadlines</a>
8080
</li>
81+
<li>
82+
<a class="function" href="#token">token</a>
83+
</li>
8184
<li>
8285
<a class="function" href="#link">link</a>
8386
</li>
@@ -639,6 +642,17 @@ <h1 class="modulename">
639642

640643
<span class="c1"># Interact with Things app</span>
641644

645+
<span class="k">def</span> <span class="nf">token</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
646+
<span class="sd">&quot;&quot;&quot;</span>
647+
<span class="sd"> Returns the API token.</span>
648+
649+
<span class="sd"> See &lt;a href=&quot;https://culturedcode.com/things/support/articles/2803573/&quot;&gt;</span>
650+
<span class="sd"> Things URL Scheme&lt;/a&gt; for details.</span>
651+
<span class="sd"> &quot;&quot;&quot;</span>
652+
<span class="n">database</span> <span class="o">=</span> <span class="n">pop_database</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
653+
654+
<span class="k">return</span> <span class="n">database</span><span class="o">.</span><span class="n">get_api_token</span><span class="p">()</span>
655+
642656

643657
<span class="k">def</span> <span class="nf">link</span><span class="p">(</span><span class="n">uuid</span><span class="p">):</span>
644658
<span class="sd">&quot;&quot;&quot;</span>
@@ -1708,6 +1722,38 @@ <h6 id="returns">Returns</h6>
17081722
</div>
17091723

17101724

1725+
</section>
1726+
<section id="token">
1727+
<div class="attr function"><a class="headerlink" href="#token">#&nbsp;&nbsp</a>
1728+
1729+
1730+
<span class="def">def</span>
1731+
<span class="name">token</span><span class="signature">(**kwargs) -&gt; str</span>:
1732+
</div>
1733+
1734+
<details>
1735+
<summary>View Source</summary>
1736+
<div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">token</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
1737+
<span class="sd">&quot;&quot;&quot;</span>
1738+
<span class="sd"> Returns the API token.</span>
1739+
1740+
<span class="sd"> See &lt;a href=&quot;https://culturedcode.com/things/support/articles/2803573/&quot;&gt;</span>
1741+
<span class="sd"> Things URL Scheme&lt;/a&gt; for details.</span>
1742+
<span class="sd"> &quot;&quot;&quot;</span>
1743+
<span class="n">database</span> <span class="o">=</span> <span class="n">pop_database</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
1744+
1745+
<span class="k">return</span> <span class="n">database</span><span class="o">.</span><span class="n">get_api_token</span><span class="p">()</span>
1746+
</pre></div>
1747+
1748+
</details>
1749+
1750+
<div class="docstring"><p>Returns the API token.</p>
1751+
1752+
<p>See <a href="https://culturedcode.com/things/support/articles/2803573/">
1753+
Things URL Scheme</a> for details.</p>
1754+
</div>
1755+
1756+
17111757
</section>
17121758
<section id="link">
17131759
<div class="attr function"><a class="headerlink" href="#link">#&nbsp;&nbsp</a>

docs/things/database.html

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ <h2>API Documentation</h2>
5454
<li>
5555
<a class="variable" href="#Database.TABLE_META">TABLE_META</a>
5656
</li>
57+
<li>
58+
<a class="variable" href="#Database.TABLE_SETTINGS">TABLE_SETTINGS</a>
59+
</li>
5760
<li>
5861
<a class="variable" href="#Database.DATE_CREATE">DATE_CREATE</a>
5962
</li>
@@ -153,6 +156,9 @@ <h2>API Documentation</h2>
153156
<li>
154157
<a class="function" href="#Database.get_version">get_version</a>
155158
</li>
159+
<li>
160+
<a class="function" href="#Database.get_api_token">get_api_token</a>
161+
</li>
156162
<li>
157163
<a class="function" href="#Database.get_count">get_count</a>
158164
</li>
@@ -312,6 +318,7 @@ <h1 class="modulename">
312318
<span class="n">TABLE_AREATAG</span> <span class="o">=</span> <span class="s2">&quot;TMAreaTag&quot;</span>
313319
<span class="n">TABLE_CHECKLIST_ITEM</span> <span class="o">=</span> <span class="s2">&quot;TMChecklistItem&quot;</span>
314320
<span class="n">TABLE_META</span> <span class="o">=</span> <span class="s2">&quot;Meta&quot;</span>
321+
<span class="n">TABLE_SETTINGS</span> <span class="o">=</span> <span class="s2">&quot;TMSettings&quot;</span>
315322
<span class="n">DATE_CREATE</span> <span class="o">=</span> <span class="s2">&quot;creationDate&quot;</span>
316323
<span class="n">DATE_MOD</span> <span class="o">=</span> <span class="s2">&quot;userModificationDate&quot;</span>
317324
<span class="n">DATE_DEADLINE</span> <span class="o">=</span> <span class="s2">&quot;dueDate&quot;</span>
@@ -647,6 +654,21 @@ <h1 class="modulename">
647654
<span class="n">plist_bytes</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">encode</span><span class="p">()</span>
648655
<span class="k">return</span> <span class="n">plistlib</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">plist_bytes</span><span class="p">)</span>
649656

657+
<span class="k">def</span> <span class="nf">get_api_token</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
658+
<span class="sd">&quot;&quot;&quot;Get Things API token.&quot;&quot;&quot;</span>
659+
660+
<span class="n">sql_query</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;&quot;&quot;</span>
661+
<span class="s2"> SELECT</span>
662+
<span class="s2"> uriSchemeAuthenticationToken</span>
663+
<span class="s2"> FROM</span>
664+
<span class="s2"> </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">TABLE_SETTINGS</span><span class="si">}</span><span class="s2"></span>
665+
<span class="s2"> WHERE</span>
666+
<span class="s2"> uuid = &#39;RhAzEf6qDxCD5PmnZVtBZR&#39;</span>
667+
<span class="s2"> &quot;&quot;&quot;</span>
668+
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute_query</span><span class="p">(</span><span class="n">sql_query</span><span class="p">,</span> <span class="n">row_factory</span><span class="o">=</span><span class="n">list_factory</span><span class="p">)</span>
669+
670+
<span class="k">return</span> <span class="n">result</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
671+
650672
<span class="k">def</span> <span class="nf">get_count</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sql</span><span class="p">):</span>
651673
<span class="sd">&quot;&quot;&quot;Count number of results.&quot;&quot;&quot;</span>
652674
<span class="n">sql_query</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;&quot;&quot;SELECT COUNT(uuid) FROM (</span><span class="si">{</span><span class="n">sql</span><span class="si">}</span><span class="s2">)&quot;&quot;&quot;</span>
@@ -990,6 +1012,7 @@ <h1 class="modulename">
9901012
<span class="n">TABLE_AREATAG</span> <span class="o">=</span> <span class="s2">&quot;TMAreaTag&quot;</span>
9911013
<span class="n">TABLE_CHECKLIST_ITEM</span> <span class="o">=</span> <span class="s2">&quot;TMChecklistItem&quot;</span>
9921014
<span class="n">TABLE_META</span> <span class="o">=</span> <span class="s2">&quot;Meta&quot;</span>
1015+
<span class="n">TABLE_SETTINGS</span> <span class="o">=</span> <span class="s2">&quot;TMSettings&quot;</span>
9931016
<span class="n">DATE_CREATE</span> <span class="o">=</span> <span class="s2">&quot;creationDate&quot;</span>
9941017
<span class="n">DATE_MOD</span> <span class="o">=</span> <span class="s2">&quot;userModificationDate&quot;</span>
9951018
<span class="n">DATE_DEADLINE</span> <span class="o">=</span> <span class="s2">&quot;dueDate&quot;</span>
@@ -1325,6 +1348,21 @@ <h1 class="modulename">
13251348
<span class="n">plist_bytes</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">encode</span><span class="p">()</span>
13261349
<span class="k">return</span> <span class="n">plistlib</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">plist_bytes</span><span class="p">)</span>
13271350

1351+
<span class="k">def</span> <span class="nf">get_api_token</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
1352+
<span class="sd">&quot;&quot;&quot;Get Things API token.&quot;&quot;&quot;</span>
1353+
1354+
<span class="n">sql_query</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;&quot;&quot;</span>
1355+
<span class="s2"> SELECT</span>
1356+
<span class="s2"> uriSchemeAuthenticationToken</span>
1357+
<span class="s2"> FROM</span>
1358+
<span class="s2"> </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">TABLE_SETTINGS</span><span class="si">}</span><span class="s2"></span>
1359+
<span class="s2"> WHERE</span>
1360+
<span class="s2"> uuid = &#39;RhAzEf6qDxCD5PmnZVtBZR&#39;</span>
1361+
<span class="s2"> &quot;&quot;&quot;</span>
1362+
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute_query</span><span class="p">(</span><span class="n">sql_query</span><span class="p">,</span> <span class="n">row_factory</span><span class="o">=</span><span class="n">list_factory</span><span class="p">)</span>
1363+
1364+
<span class="k">return</span> <span class="n">result</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
1365+
13281366
<span class="k">def</span> <span class="nf">get_count</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sql</span><span class="p">):</span>
13291367
<span class="sd">&quot;&quot;&quot;Count number of results.&quot;&quot;&quot;</span>
13301368
<span class="n">sql_query</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;&quot;&quot;SELECT COUNT(uuid) FROM (</span><span class="si">{</span><span class="n">sql</span><span class="si">}</span><span class="s2">)&quot;&quot;&quot;</span>
@@ -1655,6 +1693,15 @@ <h6 id="parameters">Parameters</h6>
16551693

16561694

16571695

1696+
</div>
1697+
<div id="Database.TABLE_SETTINGS" class="classattr">
1698+
<div class="attr variable"><a class="headerlink" href="#Database.TABLE_SETTINGS">#&nbsp;&nbsp</a>
1699+
1700+
<span class="name">TABLE_SETTINGS</span><span class="default_value"> = &#39;TMSettings&#39;</span>
1701+
</div>
1702+
1703+
1704+
16581705
</div>
16591706
<div id="Database.DATE_CREATE" class="classattr">
16601707
<div class="attr variable"><a class="headerlink" href="#Database.DATE_CREATE">#&nbsp;&nbsp</a>
@@ -2340,6 +2387,39 @@ <h6 id="parameters">Parameters</h6>
23402387
</div>
23412388

23422389

2390+
</div>
2391+
<div id="Database.get_api_token" class="classattr">
2392+
<div class="attr function"><a class="headerlink" href="#Database.get_api_token">#&nbsp;&nbsp</a>
2393+
2394+
2395+
<span class="def">def</span>
2396+
<span class="name">get_api_token</span><span class="signature">(self)</span>:
2397+
</div>
2398+
2399+
<details>
2400+
<summary>View Source</summary>
2401+
<div class="codehilite"><pre><span></span> <span class="k">def</span> <span class="nf">get_api_token</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
2402+
<span class="sd">&quot;&quot;&quot;Get Things API token.&quot;&quot;&quot;</span>
2403+
2404+
<span class="n">sql_query</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;&quot;&quot;</span>
2405+
<span class="s2"> SELECT</span>
2406+
<span class="s2"> uriSchemeAuthenticationToken</span>
2407+
<span class="s2"> FROM</span>
2408+
<span class="s2"> </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">TABLE_SETTINGS</span><span class="si">}</span><span class="s2"></span>
2409+
<span class="s2"> WHERE</span>
2410+
<span class="s2"> uuid = &#39;RhAzEf6qDxCD5PmnZVtBZR&#39;</span>
2411+
<span class="s2"> &quot;&quot;&quot;</span>
2412+
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute_query</span><span class="p">(</span><span class="n">sql_query</span><span class="p">,</span> <span class="n">row_factory</span><span class="o">=</span><span class="n">list_factory</span><span class="p">)</span>
2413+
2414+
<span class="k">return</span> <span class="n">result</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
2415+
</pre></div>
2416+
2417+
</details>
2418+
2419+
<div class="docstring"><p>Get Things API token.</p>
2420+
</div>
2421+
2422+
23432423
</div>
23442424
<div id="Database.get_count" class="classattr">
23452425
<div class="attr function"><a class="headerlink" href="#Database.get_count">#&nbsp;&nbsp</a>

0 commit comments

Comments
 (0)