omni-analytics-sdk 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- omni_analytics_sdk-1.0.0/.all-contributorsrc +36 -0
- omni_analytics_sdk-1.0.0/.github/workflows/docs.yml +38 -0
- omni_analytics_sdk-1.0.0/.github/workflows/publish.yml +23 -0
- omni_analytics_sdk-1.0.0/.github/workflows/release-please.yml +22 -0
- omni_analytics_sdk-1.0.0/.github/workflows/test.yml +26 -0
- omni_analytics_sdk-1.0.0/.gitignore +166 -0
- omni_analytics_sdk-1.0.0/CHANGELOG.md +48 -0
- omni_analytics_sdk-1.0.0/LICENSE +21 -0
- omni_analytics_sdk-1.0.0/PKG-INFO +115 -0
- omni_analytics_sdk-1.0.0/README.md +98 -0
- omni_analytics_sdk-1.0.0/cassettes/test_refresh_model +54 -0
- omni_analytics_sdk-1.0.0/docs/api/OmniApiClient.md +1 -0
- omni_analytics_sdk-1.0.0/docs/api/OmniDashboardEmbedder.md +2 -0
- omni_analytics_sdk-1.0.0/docs/api/OmniFilterDefinition.md +1 -0
- omni_analytics_sdk-1.0.0/docs/api/OmniFilterSet.md +1 -0
- omni_analytics_sdk-1.0.0/docs/index.md +37 -0
- omni_analytics_sdk-1.0.0/docs/usage/api_client.md +60 -0
- omni_analytics_sdk-1.0.0/docs/usage/dashboard_embedding.md +160 -0
- omni_analytics_sdk-1.0.0/mkdocs.yml +64 -0
- omni_analytics_sdk-1.0.0/poetry.lock +2223 -0
- omni_analytics_sdk-1.0.0/pyproject.toml +78 -0
- omni_analytics_sdk-1.0.0/src/omni/__init__.py +11 -0
- omni_analytics_sdk-1.0.0/src/omni/client.py +111 -0
- omni_analytics_sdk-1.0.0/src/omni/config.py +43 -0
- omni_analytics_sdk-1.0.0/src/omni/embed.py +335 -0
- omni_analytics_sdk-1.0.0/src/omni/utils.py +10 -0
- omni_analytics_sdk-1.0.0/tests/__init__.py +8 -0
- omni_analytics_sdk-1.0.0/tests/cassettes/test_refresh_model +56 -0
- omni_analytics_sdk-1.0.0/tests/test_client.py +23 -0
- omni_analytics_sdk-1.0.0/tests/test_embed.py +288 -0
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"files": [
|
|
3
|
+
"README.md"
|
|
4
|
+
],
|
|
5
|
+
"imageSize": 100,
|
|
6
|
+
"commit": false,
|
|
7
|
+
"commitType": "docs",
|
|
8
|
+
"commitConvention": "angular",
|
|
9
|
+
"contributors": [
|
|
10
|
+
{
|
|
11
|
+
"login": "dtiesling",
|
|
12
|
+
"name": "Danny Tiesling",
|
|
13
|
+
"avatar_url": "https://avatars.githubusercontent.com/u/7133255?v=4",
|
|
14
|
+
"profile": "https://github.com/dtiesling",
|
|
15
|
+
"contributions": [
|
|
16
|
+
"code"
|
|
17
|
+
]
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"login": "spra85",
|
|
21
|
+
"name": "Chris Sprehe",
|
|
22
|
+
"avatar_url": "https://avatars.githubusercontent.com/u/423943?v=4",
|
|
23
|
+
"profile": "https://github.com/spra85",
|
|
24
|
+
"contributions": [
|
|
25
|
+
"doc",
|
|
26
|
+
"code"
|
|
27
|
+
]
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"contributorsPerLine": 7,
|
|
31
|
+
"skipCi": true,
|
|
32
|
+
"repoType": "github",
|
|
33
|
+
"repoHost": "https://github.com",
|
|
34
|
+
"projectName": "omni-sdk",
|
|
35
|
+
"projectOwner": "tillable"
|
|
36
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
name: Docs Deploy
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
branches:
|
|
5
|
+
- master
|
|
6
|
+
- main
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: write
|
|
10
|
+
jobs:
|
|
11
|
+
deploy:
|
|
12
|
+
name: Deploy Docs to GH Pages
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
- name: Configure Git Credentials
|
|
17
|
+
run: |
|
|
18
|
+
git config user.name github-actions[bot]
|
|
19
|
+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
|
|
20
|
+
- uses: actions/setup-python@v4
|
|
21
|
+
with:
|
|
22
|
+
python-version: 3.x
|
|
23
|
+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
|
|
24
|
+
- uses: actions/cache@v3
|
|
25
|
+
with:
|
|
26
|
+
key: mkdocs-material-${{ env.cache_id }}
|
|
27
|
+
path: .cache
|
|
28
|
+
restore-keys: |
|
|
29
|
+
mkdocs-material-
|
|
30
|
+
- name: Install dependencies
|
|
31
|
+
run: |
|
|
32
|
+
pip install poetry
|
|
33
|
+
poetry install --with docs
|
|
34
|
+
- name: GH Pages deploy
|
|
35
|
+
run: |
|
|
36
|
+
poetry run mike deploy --update-aliases `poetry run hatch version` stable
|
|
37
|
+
poetry run mike set-default stable
|
|
38
|
+
git push -f origin gh-pages
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
name: Pypi Publish
|
|
2
|
+
|
|
3
|
+
on: push
|
|
4
|
+
|
|
5
|
+
env:
|
|
6
|
+
HATCH_INDEX_AUTH: ${{ secrets.HATCH_INDEX_AUTH }}
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
publish:
|
|
10
|
+
name: Pypi Publish
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
- uses: actions/setup-python@v5
|
|
16
|
+
with:
|
|
17
|
+
python-version: 3.9
|
|
18
|
+
- name: Install hatch
|
|
19
|
+
run: pip install hatch
|
|
20
|
+
- name: Publish to Pypi
|
|
21
|
+
run: |
|
|
22
|
+
hatch build
|
|
23
|
+
hatch publish -n -u __token__
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
on:
|
|
2
|
+
push:
|
|
3
|
+
branches:
|
|
4
|
+
- main
|
|
5
|
+
|
|
6
|
+
permissions: {}
|
|
7
|
+
|
|
8
|
+
name: release-please
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
release-please:
|
|
12
|
+
permissions:
|
|
13
|
+
contents: write
|
|
14
|
+
pull-requests: write
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- uses: google-github-actions/release-please-action@v4
|
|
18
|
+
with:
|
|
19
|
+
# in order to trigger other actions such as Pypi Publish
|
|
20
|
+
# need to use a PAT other than the default GITHUB_TOKEN
|
|
21
|
+
# token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
|
|
22
|
+
release-type: python
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
name: CI Testing
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
push:
|
|
8
|
+
branches:
|
|
9
|
+
- main
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
test:
|
|
13
|
+
name: Test
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
steps:
|
|
16
|
+
- uses: actions/checkout@v3
|
|
17
|
+
- uses: psf/black@stable
|
|
18
|
+
- uses: actions/setup-python@v1
|
|
19
|
+
with:
|
|
20
|
+
python-version: 3.9
|
|
21
|
+
- run: pip install poetry
|
|
22
|
+
- run: poetry install --with dev
|
|
23
|
+
- run: poetry run mypy src/
|
|
24
|
+
- run: cd tests; poetry run pytest --cov=omni
|
|
25
|
+
|
|
26
|
+
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py,cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# poetry
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
102
|
+
#poetry.lock
|
|
103
|
+
|
|
104
|
+
# pdm
|
|
105
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
106
|
+
#pdm.lock
|
|
107
|
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
108
|
+
# in version control.
|
|
109
|
+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
|
110
|
+
.pdm.toml
|
|
111
|
+
.pdm-python
|
|
112
|
+
.pdm-build/
|
|
113
|
+
|
|
114
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
115
|
+
__pypackages__/
|
|
116
|
+
|
|
117
|
+
# Celery stuff
|
|
118
|
+
celerybeat-schedule
|
|
119
|
+
celerybeat.pid
|
|
120
|
+
|
|
121
|
+
# SageMath parsed files
|
|
122
|
+
*.sage.py
|
|
123
|
+
|
|
124
|
+
# Environments
|
|
125
|
+
.env
|
|
126
|
+
.venv
|
|
127
|
+
env/
|
|
128
|
+
venv/
|
|
129
|
+
ENV/
|
|
130
|
+
env.bak/
|
|
131
|
+
venv.bak/
|
|
132
|
+
|
|
133
|
+
# Spyder project settings
|
|
134
|
+
.spyderproject
|
|
135
|
+
.spyproject
|
|
136
|
+
|
|
137
|
+
# Rope project settings
|
|
138
|
+
.ropeproject
|
|
139
|
+
|
|
140
|
+
# mkdocs documentation
|
|
141
|
+
/site
|
|
142
|
+
|
|
143
|
+
# mypy
|
|
144
|
+
.mypy_cache/
|
|
145
|
+
.dmypy.json
|
|
146
|
+
dmypy.json
|
|
147
|
+
|
|
148
|
+
# Pyre type checker
|
|
149
|
+
.pyre/
|
|
150
|
+
|
|
151
|
+
# pytype static type analyzer
|
|
152
|
+
.pytype/
|
|
153
|
+
|
|
154
|
+
# Cython debug symbols
|
|
155
|
+
cython_debug/
|
|
156
|
+
|
|
157
|
+
# PyCharm
|
|
158
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
159
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
160
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
161
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
162
|
+
#.idea/
|
|
163
|
+
|
|
164
|
+
# other
|
|
165
|
+
docs/site
|
|
166
|
+
.idea
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [1.0.0](https://github.com/camoag/omni-sdk/compare/v0.3.0-alpha...v1.0.0) (2024-07-10)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* adds helper classes for passing filter search params in embedded dashboards. ([#21](https://github.com/camoag/omni-sdk/issues/21)) ([5147dba](https://github.com/camoag/omni-sdk/commit/5147dba3fa51394e438ce6903a9baaa87f4d2278))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Miscellaneous Chores
|
|
12
|
+
|
|
13
|
+
* release 1.0.0 ([5e495ad](https://github.com/camoag/omni-sdk/commit/5e495add0d01b0e5d5503dd756b96ea50012de87))
|
|
14
|
+
|
|
15
|
+
## [0.3.0-alpha](https://github.com/tillable/omni-sdk/compare/v0.2.0-alpha...v0.3.0-alpha) (2024-07-03)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Features
|
|
19
|
+
|
|
20
|
+
* adds REST client with low level request methods and high level method to refresh models. ([#13](https://github.com/tillable/omni-sdk/issues/13)) ([cf45a30](https://github.com/tillable/omni-sdk/commit/cf45a308443e7544a85d388f56cb56043b831a8e))
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### Documentation
|
|
24
|
+
|
|
25
|
+
* add spra85 as a contributor for doc, and code ([#18](https://github.com/tillable/omni-sdk/issues/18)) ([51392f9](https://github.com/tillable/omni-sdk/commit/51392f9147a467949e40c7d8b2464fdf91e85e03))
|
|
26
|
+
|
|
27
|
+
## [0.2.0-alpha](https://github.com/tillable/omni-sdk/compare/v0.1.1-alpha...v0.2.0-alpha) (2024-07-01)
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
### Features
|
|
31
|
+
|
|
32
|
+
* support embedding urls using a vanity domain ([#15](https://github.com/tillable/omni-sdk/issues/15)) ([1d23d68](https://github.com/tillable/omni-sdk/commit/1d23d68ac570e77d50b45e0fe3e11b3a7832424b))
|
|
33
|
+
|
|
34
|
+
## [0.1.1-alpha](https://github.com/tillable/omni-sdk/compare/v0.1.0-alpha...v0.1.1-alpha) (2024-06-24)
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
### Bug Fixes
|
|
38
|
+
|
|
39
|
+
* fixes broken signatures when url embedder was given an empty string or dict for the filter_search_params. ([#12](https://github.com/tillable/omni-sdk/issues/12)) ([a4bc701](https://github.com/tillable/omni-sdk/commit/a4bc701e5c43da0018017d39332bf6c618f7c636))
|
|
40
|
+
* resolve issue with docs automation ([#2](https://github.com/tillable/omni-sdk/issues/2)) ([21848ab](https://github.com/tillable/omni-sdk/commit/21848ab430c0aac92c189f70fccc92643229ed84))
|
|
41
|
+
* resolves another issue with docs build ([#6](https://github.com/tillable/omni-sdk/issues/6)) ([c90cbef](https://github.com/tillable/omni-sdk/commit/c90cbefe5295f13f3870101b5df070f53a1d76df))
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
### Documentation
|
|
45
|
+
|
|
46
|
+
* add dtiesling as a contributor for code ([#5](https://github.com/tillable/omni-sdk/issues/5)) ([5a016c9](https://github.com/tillable/omni-sdk/commit/5a016c9c35c772e3d755cf3e972f2172a14febc6))
|
|
47
|
+
* Fixes formatting on badges. ([e5d388e](https://github.com/tillable/omni-sdk/commit/e5d388e684505528ee5684d3a498decf6f743366))
|
|
48
|
+
* fixes typos in the README and adds docstrings ([#9](https://github.com/tillable/omni-sdk/issues/9)) ([4ae0753](https://github.com/tillable/omni-sdk/commit/4ae07539658edc16f202932cf036936a621263de))
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 CamoAg
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: omni-analytics-sdk
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Omni Analytics Python SDK.
|
|
5
|
+
Project-URL: Homepage, https://tillable.github.io/omni-sdk/stable/
|
|
6
|
+
Project-URL: Repository, https://github.com/tillable/omni-sdk
|
|
7
|
+
Project-URL: Documentation, https://tillable.github.io/omni-sdk/stable/
|
|
8
|
+
Author-email: Daniel Tiesling <daniel.tiesling@camo.ag>
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
11
|
+
Classifier: Operating System :: OS Independent
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Requires-Python: >=3.9
|
|
14
|
+
Requires-Dist: python>=3.9
|
|
15
|
+
Requires-Dist: requests
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
|
|
18
|
+
[](https://github.com/tillable/omni-sdk/actions/workflows/test.yml)
|
|
19
|
+
[](#contributors-)
|
|
20
|
+
[](https://github.com/psf/black)
|
|
21
|
+
[](https://spdx.org/licenses/)
|
|
22
|
+
[](https://github.com/python/mypy)
|
|
23
|
+
|
|
24
|
+
# Omni SDK
|
|
25
|
+
|
|
26
|
+
**Unofficial SDK for [Omni Analytics](https://omni.co/)**
|
|
27
|
+
|
|
28
|
+
## Getting Started
|
|
29
|
+
|
|
30
|
+
For installation, configuration and usage view the docs [here](https://tillable.github.io/omni-sdk//#getting-started)
|
|
31
|
+
|
|
32
|
+
## Bug Reports
|
|
33
|
+
|
|
34
|
+
Submit any issues you may encounter as a [GitHub issue](https://github.com/tillable/omni-sdk/issues). Please search for
|
|
35
|
+
similar issues before submitting a new one.
|
|
36
|
+
|
|
37
|
+
## Questions, Concerns, Ideas, Support, Feature Requests
|
|
38
|
+
|
|
39
|
+
All non-bug-related discussions such as support or feature requests should be submitted as a
|
|
40
|
+
[GitHub Discussion](https://github.com/tillable/omni-sdk/discussions).
|
|
41
|
+
|
|
42
|
+
## License
|
|
43
|
+
|
|
44
|
+
MIT licensed. See the [LICENSE](./LICENSE) file for more details.
|
|
45
|
+
|
|
46
|
+
## Contributing
|
|
47
|
+
|
|
48
|
+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
|
49
|
+
|
|
50
|
+
### Development Environment
|
|
51
|
+
|
|
52
|
+
The development environment is simple and straightforward. Dependencies are managed by Poetry and tests are run
|
|
53
|
+
with pytest. If you would like to test any changes against a live server you can use any apps in the `/examples` directory.
|
|
54
|
+
|
|
55
|
+
Prerequisites:
|
|
56
|
+
- [Python >= 3.9](https://www.python.org/downloads/)
|
|
57
|
+
- [Poetry](https://python-poetry.org/docs/#installation)
|
|
58
|
+
|
|
59
|
+
Install dependencies.
|
|
60
|
+
```bash
|
|
61
|
+
poetry install
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Run tests.
|
|
65
|
+
```bash
|
|
66
|
+
poetry run pytest
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Code Style
|
|
70
|
+
|
|
71
|
+
- Code is formatted using [black](https://black.readthedocs.io/en/stable/).
|
|
72
|
+
- Typing is enforced with [mypy](https://mypy.readthedocs.io/en/stable/).
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### How should I write my commits?
|
|
76
|
+
|
|
77
|
+
This project uses [release please](https://github.com/googleapis/release-please) and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for versioning releases.
|
|
78
|
+
|
|
79
|
+
Per [release-please-action](https://github.com/google-github-actions/release-please-action):
|
|
80
|
+
|
|
81
|
+
> The most important prefixes you should have in mind are:
|
|
82
|
+
>
|
|
83
|
+
> - `fix``: which represents bug fixes, and correlates to a SemVer patch.
|
|
84
|
+
> - `feat``: which represents a new feature, and correlates to a SemVer minor.
|
|
85
|
+
> - `feat!``:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.
|
|
86
|
+
|
|
87
|
+
Any PR with `fix`, `feat`, `docs`, or a conventional commit with an `!` will trigger a release PR when merged.
|
|
88
|
+
|
|
89
|
+
Other conventional commits such as `chore`, `ci`, `test`, `refactor`, etc will not trigger a release but are encouraged to form a standard around conventional commits in the commit history.
|
|
90
|
+
|
|
91
|
+
## Contributors
|
|
92
|
+
|
|
93
|
+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
94
|
+
<!-- prettier-ignore-start -->
|
|
95
|
+
<!-- markdownlint-disable -->
|
|
96
|
+
<table>
|
|
97
|
+
<tbody>
|
|
98
|
+
<tr>
|
|
99
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/dtiesling"><img src="https://avatars.githubusercontent.com/u/7133255?v=4?s=100" width="100px;" alt="Danny Tiesling"/><br /><sub><b>Danny Tiesling</b></sub></a><br /><a href="https://github.com/tillable/omni-sdk/commits?author=dtiesling" title="Code">💻</a></td>
|
|
100
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/spra85"><img src="https://avatars.githubusercontent.com/u/423943?v=4?s=100" width="100px;" alt="Chris Sprehe"/><br /><sub><b>Chris Sprehe</b></sub></a><br /><a href="https://github.com/tillable/omni-sdk/commits?author=spra85" title="Documentation">📖</a> <a href="https://github.com/tillable/omni-sdk/commits?author=spra85" title="Code">💻</a></td>
|
|
101
|
+
</tr>
|
|
102
|
+
</tbody>
|
|
103
|
+
</table>
|
|
104
|
+
|
|
105
|
+
<!-- markdownlint-restore -->
|
|
106
|
+
<!-- prettier-ignore-end -->
|
|
107
|
+
|
|
108
|
+
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
109
|
+
<!-- prettier-ignore-start -->
|
|
110
|
+
<!-- markdownlint-disable -->
|
|
111
|
+
|
|
112
|
+
<!-- markdownlint-restore -->
|
|
113
|
+
<!-- prettier-ignore-end -->
|
|
114
|
+
|
|
115
|
+
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
[](https://github.com/tillable/omni-sdk/actions/workflows/test.yml)
|
|
2
|
+
[](#contributors-)
|
|
3
|
+
[](https://github.com/psf/black)
|
|
4
|
+
[](https://spdx.org/licenses/)
|
|
5
|
+
[](https://github.com/python/mypy)
|
|
6
|
+
|
|
7
|
+
# Omni SDK
|
|
8
|
+
|
|
9
|
+
**Unofficial SDK for [Omni Analytics](https://omni.co/)**
|
|
10
|
+
|
|
11
|
+
## Getting Started
|
|
12
|
+
|
|
13
|
+
For installation, configuration and usage view the docs [here](https://tillable.github.io/omni-sdk//#getting-started)
|
|
14
|
+
|
|
15
|
+
## Bug Reports
|
|
16
|
+
|
|
17
|
+
Submit any issues you may encounter as a [GitHub issue](https://github.com/tillable/omni-sdk/issues). Please search for
|
|
18
|
+
similar issues before submitting a new one.
|
|
19
|
+
|
|
20
|
+
## Questions, Concerns, Ideas, Support, Feature Requests
|
|
21
|
+
|
|
22
|
+
All non-bug-related discussions such as support or feature requests should be submitted as a
|
|
23
|
+
[GitHub Discussion](https://github.com/tillable/omni-sdk/discussions).
|
|
24
|
+
|
|
25
|
+
## License
|
|
26
|
+
|
|
27
|
+
MIT licensed. See the [LICENSE](./LICENSE) file for more details.
|
|
28
|
+
|
|
29
|
+
## Contributing
|
|
30
|
+
|
|
31
|
+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
|
32
|
+
|
|
33
|
+
### Development Environment
|
|
34
|
+
|
|
35
|
+
The development environment is simple and straightforward. Dependencies are managed by Poetry and tests are run
|
|
36
|
+
with pytest. If you would like to test any changes against a live server you can use any apps in the `/examples` directory.
|
|
37
|
+
|
|
38
|
+
Prerequisites:
|
|
39
|
+
- [Python >= 3.9](https://www.python.org/downloads/)
|
|
40
|
+
- [Poetry](https://python-poetry.org/docs/#installation)
|
|
41
|
+
|
|
42
|
+
Install dependencies.
|
|
43
|
+
```bash
|
|
44
|
+
poetry install
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Run tests.
|
|
48
|
+
```bash
|
|
49
|
+
poetry run pytest
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Code Style
|
|
53
|
+
|
|
54
|
+
- Code is formatted using [black](https://black.readthedocs.io/en/stable/).
|
|
55
|
+
- Typing is enforced with [mypy](https://mypy.readthedocs.io/en/stable/).
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### How should I write my commits?
|
|
59
|
+
|
|
60
|
+
This project uses [release please](https://github.com/googleapis/release-please) and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for versioning releases.
|
|
61
|
+
|
|
62
|
+
Per [release-please-action](https://github.com/google-github-actions/release-please-action):
|
|
63
|
+
|
|
64
|
+
> The most important prefixes you should have in mind are:
|
|
65
|
+
>
|
|
66
|
+
> - `fix``: which represents bug fixes, and correlates to a SemVer patch.
|
|
67
|
+
> - `feat``: which represents a new feature, and correlates to a SemVer minor.
|
|
68
|
+
> - `feat!``:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.
|
|
69
|
+
|
|
70
|
+
Any PR with `fix`, `feat`, `docs`, or a conventional commit with an `!` will trigger a release PR when merged.
|
|
71
|
+
|
|
72
|
+
Other conventional commits such as `chore`, `ci`, `test`, `refactor`, etc will not trigger a release but are encouraged to form a standard around conventional commits in the commit history.
|
|
73
|
+
|
|
74
|
+
## Contributors
|
|
75
|
+
|
|
76
|
+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
77
|
+
<!-- prettier-ignore-start -->
|
|
78
|
+
<!-- markdownlint-disable -->
|
|
79
|
+
<table>
|
|
80
|
+
<tbody>
|
|
81
|
+
<tr>
|
|
82
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/dtiesling"><img src="https://avatars.githubusercontent.com/u/7133255?v=4?s=100" width="100px;" alt="Danny Tiesling"/><br /><sub><b>Danny Tiesling</b></sub></a><br /><a href="https://github.com/tillable/omni-sdk/commits?author=dtiesling" title="Code">💻</a></td>
|
|
83
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/spra85"><img src="https://avatars.githubusercontent.com/u/423943?v=4?s=100" width="100px;" alt="Chris Sprehe"/><br /><sub><b>Chris Sprehe</b></sub></a><br /><a href="https://github.com/tillable/omni-sdk/commits?author=spra85" title="Documentation">📖</a> <a href="https://github.com/tillable/omni-sdk/commits?author=spra85" title="Code">💻</a></td>
|
|
84
|
+
</tr>
|
|
85
|
+
</tbody>
|
|
86
|
+
</table>
|
|
87
|
+
|
|
88
|
+
<!-- markdownlint-restore -->
|
|
89
|
+
<!-- prettier-ignore-end -->
|
|
90
|
+
|
|
91
|
+
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
92
|
+
<!-- prettier-ignore-start -->
|
|
93
|
+
<!-- markdownlint-disable -->
|
|
94
|
+
|
|
95
|
+
<!-- markdownlint-restore -->
|
|
96
|
+
<!-- prettier-ignore-end -->
|
|
97
|
+
|
|
98
|
+
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
interactions:
|
|
2
|
+
- request:
|
|
3
|
+
body: null
|
|
4
|
+
headers:
|
|
5
|
+
Accept:
|
|
6
|
+
- '*/*'
|
|
7
|
+
Accept-Encoding:
|
|
8
|
+
- gzip, deflate
|
|
9
|
+
Connection:
|
|
10
|
+
- keep-alive
|
|
11
|
+
Content-Length:
|
|
12
|
+
- '0'
|
|
13
|
+
User-Agent:
|
|
14
|
+
- python-requests/2.32.3
|
|
15
|
+
method: POST
|
|
16
|
+
uri: https://test.omniapp.co/api/v0/model/b4dd2fbc-2b0c-4ae9-8f93-16a53f395514/refresh
|
|
17
|
+
response:
|
|
18
|
+
body:
|
|
19
|
+
string: '{"message":"Not found"}'
|
|
20
|
+
headers:
|
|
21
|
+
Cache-Control:
|
|
22
|
+
- no-cache, no-store
|
|
23
|
+
Connection:
|
|
24
|
+
- keep-alive
|
|
25
|
+
Content-Length:
|
|
26
|
+
- '23'
|
|
27
|
+
Content-Type:
|
|
28
|
+
- application/json; charset=utf-8
|
|
29
|
+
Date:
|
|
30
|
+
- Wed, 03 Jul 2024 04:07:23 GMT
|
|
31
|
+
ETag:
|
|
32
|
+
- W/"17-JG2JTE6to/D4sxc2pRx7Kk+opAc"
|
|
33
|
+
Expires:
|
|
34
|
+
- '0'
|
|
35
|
+
Permissions-Policy:
|
|
36
|
+
- microphone=(), camera=(), geolocation=()
|
|
37
|
+
Pragma:
|
|
38
|
+
- no-cache
|
|
39
|
+
Referrer-Policy:
|
|
40
|
+
- strict-origin-when-cross-origin
|
|
41
|
+
Strict-Transport-Security:
|
|
42
|
+
- max-age=31536000; includeSubDomains
|
|
43
|
+
Vary:
|
|
44
|
+
- Accept-Encoding
|
|
45
|
+
X-Content-Type-Options:
|
|
46
|
+
- nosniff
|
|
47
|
+
X-XSS-Protection:
|
|
48
|
+
- 1; mode=block
|
|
49
|
+
x-trace-id:
|
|
50
|
+
- Root=1-6684ce7b-554e4377183f2dba67e508aa
|
|
51
|
+
status:
|
|
52
|
+
code: 404
|
|
53
|
+
message: Not Found
|
|
54
|
+
version: 1
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
::: omni.OmniApiClient
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
::: omni.OmniFilterDefinition
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
::: omni.OmniFilterSet
|