Skip to content

Commit b0cc526

Browse files
committed
deploy: c144de9
1 parent 7b0ed8d commit b0cc526

File tree

10 files changed

+2892
-20
lines changed

10 files changed

+2892
-20
lines changed

_autosummary/obelisk.types.IngestMode.html

Lines changed: 768 additions & 1 deletion
Large diffs are not rendered by default.

_autosummary/obelisk.types.ObeliskKind.html

Lines changed: 768 additions & 1 deletion
Large diffs are not rendered by default.

_autosummary/obelisk.types.TimestampPrecision.html

Lines changed: 768 additions & 1 deletion
Large diffs are not rendered by default.

_modules/obelisk/types.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@
3131
<div class="body" role="main">
3232

3333
<h1>Source code for obelisk.types</h1><div class="highlight"><pre>
34-
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">enum</span><span class="w"> </span><span class="kn">import</span> <span class="n">Enum</span>
34+
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">enum</span><span class="w"> </span><span class="kn">import</span> <span class="n">StrEnum</span>
3535
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Optional</span>
3636

3737
<span class="kn">from</span><span class="w"> </span><span class="nn">pydantic</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseModel</span>
3838

3939

4040
<div class="viewcode-block" id="IngestMode">
4141
<a class="viewcode-back" href="../../_autosummary/obelisk.types.IngestMode.html#obelisk.types.IngestMode">[docs]</a>
42-
<span class="k">class</span><span class="w"> </span><span class="nc">IngestMode</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
42+
<span class="k">class</span><span class="w"> </span><span class="nc">IngestMode</span><span class="p">(</span><span class="n">StrEnum</span><span class="p">):</span>
4343
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
4444
<span class="sd"> Classic Obelisk accepts three ways of submitting new data.</span>
4545
<span class="sd"> This integrates with the concept of Streams,</span>
@@ -60,7 +60,7 @@ <h1>Source code for obelisk.types</h1><div class="highlight"><pre>
6060

6161
<div class="viewcode-block" id="TimestampPrecision">
6262
<a class="viewcode-back" href="../../_autosummary/obelisk.types.TimestampPrecision.html#obelisk.types.TimestampPrecision">[docs]</a>
63-
<span class="k">class</span><span class="w"> </span><span class="nc">TimestampPrecision</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
63+
<span class="k">class</span><span class="w"> </span><span class="nc">TimestampPrecision</span><span class="p">(</span><span class="n">StrEnum</span><span class="p">):</span>
6464
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
6565
<span class="sd"> When ingesting data it is important to specify which precision provided UNIX timestamps are in.</span>
6666
<span class="sd"> If a provided timestamp is in seconds,</span>
@@ -83,7 +83,7 @@ <h1>Source code for obelisk.types</h1><div class="highlight"><pre>
8383
<span class="n">dataset</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
8484
<span class="n">metric</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
8585
<span class="n">source</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
86-
<span class="n">userId</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># Only if HFS and no other name for field</span></div>
86+
<span class="n">userId</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># Only if HFS and no other name for field</span></div>
8787

8888

8989

@@ -97,7 +97,7 @@ <h1>Source code for obelisk.types</h1><div class="highlight"><pre>
9797

9898
<div class="viewcode-block" id="ObeliskKind">
9999
<a class="viewcode-back" href="../../_autosummary/obelisk.types.ObeliskKind.html#obelisk.types.ObeliskKind">[docs]</a>
100-
<span class="k">class</span><span class="w"> </span><span class="nc">ObeliskKind</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
100+
<span class="k">class</span><span class="w"> </span><span class="nc">ObeliskKind</span><span class="p">(</span><span class="n">StrEnum</span><span class="p">):</span>
101101
<span class="n">CLASSIC</span> <span class="o">=</span> <span class="s1">&#39;classic&#39;</span>
102102
<span class="n">HFS</span> <span class="o">=</span> <span class="s1">&#39;hfs&#39;</span></div>
103103

_sources/_autosummary/obelisk.types.IngestMode.rst.txt

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
obelisk.types.IngestMode
1+
obelisk.types.IngestMode
22
========================
33

44
.. currentmodule:: obelisk.types
@@ -12,6 +12,59 @@ obelisk.types.IngestMode
1212
.. automethod:: __init__
1313

1414

15+
.. rubric:: Methods
16+
17+
.. autosummary::
18+
19+
~IngestMode.encode
20+
~IngestMode.replace
21+
~IngestMode.split
22+
~IngestMode.rsplit
23+
~IngestMode.join
24+
~IngestMode.capitalize
25+
~IngestMode.casefold
26+
~IngestMode.title
27+
~IngestMode.center
28+
~IngestMode.count
29+
~IngestMode.expandtabs
30+
~IngestMode.find
31+
~IngestMode.partition
32+
~IngestMode.index
33+
~IngestMode.ljust
34+
~IngestMode.lower
35+
~IngestMode.lstrip
36+
~IngestMode.rfind
37+
~IngestMode.rindex
38+
~IngestMode.rjust
39+
~IngestMode.rstrip
40+
~IngestMode.rpartition
41+
~IngestMode.splitlines
42+
~IngestMode.strip
43+
~IngestMode.swapcase
44+
~IngestMode.translate
45+
~IngestMode.upper
46+
~IngestMode.startswith
47+
~IngestMode.endswith
48+
~IngestMode.removeprefix
49+
~IngestMode.removesuffix
50+
~IngestMode.isascii
51+
~IngestMode.islower
52+
~IngestMode.isupper
53+
~IngestMode.istitle
54+
~IngestMode.isspace
55+
~IngestMode.isdecimal
56+
~IngestMode.isdigit
57+
~IngestMode.isnumeric
58+
~IngestMode.isalpha
59+
~IngestMode.isalnum
60+
~IngestMode.isidentifier
61+
~IngestMode.isprintable
62+
~IngestMode.zfill
63+
~IngestMode.format
64+
~IngestMode.format_map
65+
~IngestMode.maketrans
66+
~IngestMode.__init__
67+
1568

1669

1770

_sources/_autosummary/obelisk.types.ObeliskKind.rst.txt

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
obelisk.types.ObeliskKind
1+
obelisk.types.ObeliskKind
22
=========================
33

44
.. currentmodule:: obelisk.types
@@ -12,6 +12,59 @@ obelisk.types.ObeliskKind
1212
.. automethod:: __init__
1313

1414

15+
.. rubric:: Methods
16+
17+
.. autosummary::
18+
19+
~ObeliskKind.encode
20+
~ObeliskKind.replace
21+
~ObeliskKind.split
22+
~ObeliskKind.rsplit
23+
~ObeliskKind.join
24+
~ObeliskKind.capitalize
25+
~ObeliskKind.casefold
26+
~ObeliskKind.title
27+
~ObeliskKind.center
28+
~ObeliskKind.count
29+
~ObeliskKind.expandtabs
30+
~ObeliskKind.find
31+
~ObeliskKind.partition
32+
~ObeliskKind.index
33+
~ObeliskKind.ljust
34+
~ObeliskKind.lower
35+
~ObeliskKind.lstrip
36+
~ObeliskKind.rfind
37+
~ObeliskKind.rindex
38+
~ObeliskKind.rjust
39+
~ObeliskKind.rstrip
40+
~ObeliskKind.rpartition
41+
~ObeliskKind.splitlines
42+
~ObeliskKind.strip
43+
~ObeliskKind.swapcase
44+
~ObeliskKind.translate
45+
~ObeliskKind.upper
46+
~ObeliskKind.startswith
47+
~ObeliskKind.endswith
48+
~ObeliskKind.removeprefix
49+
~ObeliskKind.removesuffix
50+
~ObeliskKind.isascii
51+
~ObeliskKind.islower
52+
~ObeliskKind.isupper
53+
~ObeliskKind.istitle
54+
~ObeliskKind.isspace
55+
~ObeliskKind.isdecimal
56+
~ObeliskKind.isdigit
57+
~ObeliskKind.isnumeric
58+
~ObeliskKind.isalpha
59+
~ObeliskKind.isalnum
60+
~ObeliskKind.isidentifier
61+
~ObeliskKind.isprintable
62+
~ObeliskKind.zfill
63+
~ObeliskKind.format
64+
~ObeliskKind.format_map
65+
~ObeliskKind.maketrans
66+
~ObeliskKind.__init__
67+
1568

1669

1770

_sources/_autosummary/obelisk.types.TimestampPrecision.rst.txt

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
obelisk.types.TimestampPrecision
1+
obelisk.types.TimestampPrecision
22
================================
33

44
.. currentmodule:: obelisk.types
@@ -12,6 +12,59 @@ obelisk.types.TimestampPrecision
1212
.. automethod:: __init__
1313

1414

15+
.. rubric:: Methods
16+
17+
.. autosummary::
18+
19+
~TimestampPrecision.encode
20+
~TimestampPrecision.replace
21+
~TimestampPrecision.split
22+
~TimestampPrecision.rsplit
23+
~TimestampPrecision.join
24+
~TimestampPrecision.capitalize
25+
~TimestampPrecision.casefold
26+
~TimestampPrecision.title
27+
~TimestampPrecision.center
28+
~TimestampPrecision.count
29+
~TimestampPrecision.expandtabs
30+
~TimestampPrecision.find
31+
~TimestampPrecision.partition
32+
~TimestampPrecision.index
33+
~TimestampPrecision.ljust
34+
~TimestampPrecision.lower
35+
~TimestampPrecision.lstrip
36+
~TimestampPrecision.rfind
37+
~TimestampPrecision.rindex
38+
~TimestampPrecision.rjust
39+
~TimestampPrecision.rstrip
40+
~TimestampPrecision.rpartition
41+
~TimestampPrecision.splitlines
42+
~TimestampPrecision.strip
43+
~TimestampPrecision.swapcase
44+
~TimestampPrecision.translate
45+
~TimestampPrecision.upper
46+
~TimestampPrecision.startswith
47+
~TimestampPrecision.endswith
48+
~TimestampPrecision.removeprefix
49+
~TimestampPrecision.removesuffix
50+
~TimestampPrecision.isascii
51+
~TimestampPrecision.islower
52+
~TimestampPrecision.isupper
53+
~TimestampPrecision.istitle
54+
~TimestampPrecision.isspace
55+
~TimestampPrecision.isdecimal
56+
~TimestampPrecision.isdigit
57+
~TimestampPrecision.isnumeric
58+
~TimestampPrecision.isalpha
59+
~TimestampPrecision.isalnum
60+
~TimestampPrecision.isidentifier
61+
~TimestampPrecision.isprintable
62+
~TimestampPrecision.zfill
63+
~TimestampPrecision.format
64+
~TimestampPrecision.format_map
65+
~TimestampPrecision.maketrans
66+
~TimestampPrecision.__init__
67+
1568

1669

1770

0 commit comments

Comments
 (0)