## Project description
# OmniIndex Python Library
The OmniIndex Python library provides convenient access to the OmniIndex API from applications written in the Python language. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses which makes it compatible with a wide range of versions of the OmniIndex API.
You can find usage examples for the OmniIndex Python library in our [Python Library reference](https://omniindex.readthedocs.io/) which includes code samples etc
For just the [API reference](https://app.swaggerhub.com/apis-docs/OmniIndexAPI/OmniIndex/1.0.0)
## Installation
You don't need this source code unless you want to modify the package. If you just want to use the package, just run:
```bash
pip install --upgrade omniindex
```
Install from source with:
```bash
pip setup.py install
```
## Usage
The library needs to be configured with your account's secret keys which are available from your account onboarding packet. Set them as the OMNIINDEX_API_PASSWORD environment variable before using the library:
We would recommed you set these for
* OMNIINDEX_API_PASSWORD
* OMNIINDEX_API_USER
* OMNIINDEX_API_NODE
* OMNIINDEX_API_TYPE
* OMNIINDEX_API_UNIT
* OMNIINDEX_API_BASE_URL
Linux / bash etc
```bash
export OMNIINDEX_API_PASSWORD='sk-...'
```
Windows
```bash
setx OMNIINDEX_API_PASSWORD 'sk-...'
```
Raw data
{
"_id": null,
"home_page": "https://github.com/OmniIndex/python",
"name": "omniindex",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "James Stanbridge",
"author_email": "james@omniindex.io",
"download_url": "https://files.pythonhosted.org/packages/e3/d6/1b574bf07c76ee9cf373f9e99a6fdeb4fa39529243e2c9e0f95b2d846e31/omniindex-0.1.15.tar.gz",
"platform": null,
"description": "## Project description\n\n# OmniIndex Python Library\n\nThe OmniIndex Python library provides convenient access to the OmniIndex API from applications written in the Python language. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses which makes it compatible with a wide range of versions of the OmniIndex API.\n\nYou can find usage examples for the OmniIndex Python library in our [Python Library reference](https://omniindex.readthedocs.io/) which includes code samples etc\nFor just the [API reference](https://app.swaggerhub.com/apis-docs/OmniIndexAPI/OmniIndex/1.0.0)\n\n## Installation\n\nYou don't need this source code unless you want to modify the package. If you just want to use the package, just run:\n\n```bash\npip install --upgrade omniindex\n```\n\nInstall from source with:\n\n```bash\npip setup.py install\n```\n\n## Usage\n\nThe library needs to be configured with your account's secret keys which are available from your account onboarding packet. Set them as the OMNIINDEX_API_PASSWORD environment variable before using the library:\nWe would recommed you set these for\n\n* OMNIINDEX_API_PASSWORD\n* OMNIINDEX_API_USER\n* OMNIINDEX_API_NODE\n* OMNIINDEX_API_TYPE\n* OMNIINDEX_API_UNIT\n* OMNIINDEX_API_BASE_URL\n\nLinux / bash etc\n\n```bash\nexport OMNIINDEX_API_PASSWORD='sk-...'\n```\n\nWindows\n\n```bash\nsetx OMNIINDEX_API_PASSWORD 'sk-...'\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python package for interacting with the OmniIndex Homomorphic Encrypted Blockchain API",
"version": "0.1.15",
"project_urls": {
"Homepage": "https://github.com/OmniIndex/python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a37be5957c81bd18489d30a6349465327ed6fc0a7c5f7292d4a5946c4471fede",
"md5": "a87e25fa70ab22a498db0918f90b947e",
"sha256": "53c7d5ff513aaff7884b82fbfef7315173c1f48ff6f181eaaeb9741409239e17"
},
"downloads": -1,
"filename": "omniindex-0.1.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a87e25fa70ab22a498db0918f90b947e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6940,
"upload_time": "2023-09-22T16:52:30",
"upload_time_iso_8601": "2023-09-22T16:52:30.916274Z",
"url": "https://files.pythonhosted.org/packages/a3/7b/e5957c81bd18489d30a6349465327ed6fc0a7c5f7292d4a5946c4471fede/omniindex-0.1.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e3d61b574bf07c76ee9cf373f9e99a6fdeb4fa39529243e2c9e0f95b2d846e31",
"md5": "23af0125420ae2b80a5bc6a3cc55b2e6",
"sha256": "852396df9beaa127ac11a6675c516209a4fda3b692bf2436811dd9929a41f5f1"
},
"downloads": -1,
"filename": "omniindex-0.1.15.tar.gz",
"has_sig": false,
"md5_digest": "23af0125420ae2b80a5bc6a3cc55b2e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6664,
"upload_time": "2023-09-22T16:52:32",
"upload_time_iso_8601": "2023-09-22T16:52:32.437327Z",
"url": "https://files.pythonhosted.org/packages/e3/d6/1b574bf07c76ee9cf373f9e99a6fdeb4fa39529243e2c9e0f95b2d846e31/omniindex-0.1.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-22 16:52:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OmniIndex",
"github_project": "python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "alabaster",
"specs": [
[
"==",
"0.7.13"
]
]
},
{
"name": "appdirs",
"specs": [
[
"==",
"1.4.4"
]
]
},
{
"name": "attrs",
"specs": [
[
"==",
"23.1.0"
]
]
},
{
"name": "Babel",
"specs": [
[
"==",
"2.12.1"
]
]
},
{
"name": "cattrs",
"specs": [
[
"==",
"22.2.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2023.7.22"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.1.0"
]
]
},
{
"name": "commonmark",
"specs": [
[
"==",
"0.9.1"
]
]
},
{
"name": "Delorean",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.18.1"
]
]
},
{
"name": "esbonio",
"specs": [
[
"==",
"0.16.1"
]
]
},
{
"name": "exceptiongroup",
"specs": [
[
"==",
"1.1.1"
]
]
},
{
"name": "humanize",
"specs": [
[
"==",
"4.6.0"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.4"
]
]
},
{
"name": "imagesize",
"specs": [
[
"==",
"1.4.1"
]
]
},
{
"name": "iniconfig",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "Jinja2",
"specs": [
[
"==",
"3.1.2"
]
]
},
{
"name": "lsprotocol",
"specs": [
[
"==",
"2023.0.0a1"
]
]
},
{
"name": "MarkupSafe",
"specs": [
[
"==",
"2.1.2"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"1.24.3"
]
]
},
{
"name": "omniindex",
"specs": [
[
"==",
"0.1.14"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"23.1"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.0.1"
]
]
},
{
"name": "pluggy",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "pygls",
"specs": [
[
"==",
"1.0.2"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.15.1"
]
]
},
{
"name": "pyspellchecker",
"specs": [
[
"==",
"0.7.2"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"7.3.1"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.8.2"
]
]
},
{
"name": "pytz",
"specs": [
[
"==",
"2023.3"
]
]
},
{
"name": "recommonmark",
"specs": [
[
"==",
"0.7.1"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "simplejson",
"specs": [
[
"==",
"3.19.1"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "snowballstemmer",
"specs": [
[
"==",
"2.2.0"
]
]
},
{
"name": "Sphinx",
"specs": [
[
"==",
"6.2.1"
]
]
},
{
"name": "sphinx-rtd-theme",
"specs": [
[
"==",
"1.2.0"
]
]
},
{
"name": "sphinxcontrib-applehelp",
"specs": [
[
"==",
"1.0.4"
]
]
},
{
"name": "sphinxcontrib-devhelp",
"specs": [
[
"==",
"1.0.2"
]
]
},
{
"name": "sphinxcontrib-htmlhelp",
"specs": [
[
"==",
"2.0.1"
]
]
},
{
"name": "sphinxcontrib-jquery",
"specs": [
[
"==",
"4.1"
]
]
},
{
"name": "sphinxcontrib-jsmath",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "sphinxcontrib-qthelp",
"specs": [
[
"==",
"1.0.3"
]
]
},
{
"name": "sphinxcontrib-serializinghtml",
"specs": [
[
"==",
"1.1.5"
]
]
},
{
"name": "tomli",
"specs": [
[
"==",
"2.0.1"
]
]
},
{
"name": "typeguard",
"specs": [
[
"==",
"3.0.2"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.5.0"
]
]
},
{
"name": "tzdata",
"specs": [
[
"==",
"2023.3"
]
]
},
{
"name": "tzlocal",
"specs": [
[
"==",
"5.0.1"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.0.2"
]
]
}
],
"lcname": "omniindex"
}
JSON
