# [Omni (x)Extensions](http://omnix.hive.pt)
Simple web application consuming the Omni API.
This application may be used as a supervisor of the Omni Platform to run tasks in an async
fashion, this way it's possible to remove async tasks from the Omni core.
## Usage
One must define a series of configuration values in order to correctly use the automated
part of the omni extension (supervisor).
| Name | Type | Default | Description |
| --------------------------- | ------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **OMNIX_REMOTE** | `bool` | `False` | If the remote URL should be used as the default one (legacy). |
| **OMNIX_USERNAME** | `str` | `None` | The username to be used for authentication on the omni service. |
| **OMNIX_PASSWORD** | `str` | `None` | The password value used in the authentication on the omni service, notice that this value will be sent in plain text (using an SSL encrypted connection). |
| **OMNIX_CLIENT_ID** | `str` | `None` | The identifier of the Omni API client to be used for authentication. |
| **OMNIX_CLIENT_SECRET** | `str` | `None` | The secret string to be used by the Omni API client for authentication. |
| **OMNIX_QUEUE** | `str` | `omnix` | The name of AMQP queue that is going to be used. |
| **OMNIX_RECORD_CHUNK** | `int` | `300` | The size of record chunk to be used by the scheduler (use carefully to avoid memory issues). |
| **OMNIX_BIRTHDAY_TEMPLATE** | `str` | `None` | If set allows for a remote definition of the base template to be used for email sending. |
| **REMOTE** | `bool` | `False` | If the remove mode should be used (production URL creation). |
| **OMNIX_REMOTE** | `bool` | `False` | Same as `REMOTE`. |
| **OMNIX_SCHEDULE** | `bool` | `True` | If the scheduling (background) operations of the Omnix should be enabled (defaults to `True`). |
| **REDIRECT_URL** | `str` | `None` | The URL that will be used for OAuth2 based callbacks. |
Additionally one must also configure the MongoDB and RabbitMQ instances to be able to execute
the proper master and slave supervisors. For that use the `MONGOHQ_URL` and `CLOUDAMQP_URL` variables.
## License
Omnix is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
## Build Automation
[](https://travis-ci.com/github/hivesolutions/omnix)
[](https://coveralls.io/r/hivesolutions/omnix?branch=master)
[](https://pypi.python.org/pypi/omnix)
[](https://www.apache.org/licenses/)
Raw data
{
"_id": null,
"home_page": "http://omnix.hive.pt",
"name": "omnix",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "omni extensions erp",
"author": "Hive Solutions Lda.",
"author_email": "development@hive.pt",
"download_url": "https://files.pythonhosted.org/packages/9c/e1/ec945465d42e57b9f8155221db1aef7c54bed5e849a805b51cbe43f9b168/omnix-0.3.6.tar.gz",
"platform": null,
"description": "# [Omni (x)Extensions](http://omnix.hive.pt)\n\nSimple web application consuming the Omni API.\n\nThis application may be used as a supervisor of the Omni Platform to run tasks in an async\nfashion, this way it's possible to remove async tasks from the Omni core.\n\n## Usage\n\nOne must define a series of configuration values in order to correctly use the automated\npart of the omni extension (supervisor).\n\n| Name | Type | Default | Description |\n| --------------------------- | ------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **OMNIX_REMOTE** | `bool` | `False` | If the remote URL should be used as the default one (legacy). |\n| **OMNIX_USERNAME** | `str` | `None` | The username to be used for authentication on the omni service. |\n| **OMNIX_PASSWORD** | `str` | `None` | The password value used in the authentication on the omni service, notice that this value will be sent in plain text (using an SSL encrypted connection). |\n| **OMNIX_CLIENT_ID** | `str` | `None` | The identifier of the Omni API client to be used for authentication. |\n| **OMNIX_CLIENT_SECRET** | `str` | `None` | The secret string to be used by the Omni API client for authentication. |\n| **OMNIX_QUEUE** | `str` | `omnix` | The name of AMQP queue that is going to be used. |\n| **OMNIX_RECORD_CHUNK** | `int` | `300` | The size of record chunk to be used by the scheduler (use carefully to avoid memory issues). |\n| **OMNIX_BIRTHDAY_TEMPLATE** | `str` | `None` | If set allows for a remote definition of the base template to be used for email sending. |\n| **REMOTE** | `bool` | `False` | If the remove mode should be used (production URL creation). |\n| **OMNIX_REMOTE** | `bool` | `False` | Same as `REMOTE`. |\n| **OMNIX_SCHEDULE** | `bool` | `True` | If the scheduling (background) operations of the Omnix should be enabled (defaults to `True`). |\n| **REDIRECT_URL** | `str` | `None` | The URL that will be used for OAuth2 based callbacks. |\n\nAdditionally one must also configure the MongoDB and RabbitMQ instances to be able to execute\nthe proper master and slave supervisors. For that use the `MONGOHQ_URL` and `CLOUDAMQP_URL` variables.\n\n## License\n\nOmnix is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).\n\n## Build Automation\n\n[](https://travis-ci.com/github/hivesolutions/omnix)\n[](https://coveralls.io/r/hivesolutions/omnix?branch=master)\n[](https://pypi.python.org/pypi/omnix)\n[](https://www.apache.org/licenses/)\n\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Omnix System",
"version": "0.3.6",
"project_urls": {
"Homepage": "http://omnix.hive.pt"
},
"split_keywords": [
"omni",
"extensions",
"erp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a3e8bd504482e5d93f424e1c5657b9c895157379b807bd9304e7a0cf0c64bde6",
"md5": "1cad88750c558ef5063da5c93b331bae",
"sha256": "a87cf64d569a3f3faebe8d0b7f8d50866a56be86327826fd22171b0c93aac813"
},
"downloads": -1,
"filename": "omnix-0.3.6-py2-none-any.whl",
"has_sig": false,
"md5_digest": "1cad88750c558ef5063da5c93b331bae",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 99774,
"upload_time": "2024-04-05T22:12:25",
"upload_time_iso_8601": "2024-04-05T22:12:25.094721Z",
"url": "https://files.pythonhosted.org/packages/a3/e8/bd504482e5d93f424e1c5657b9c895157379b807bd9304e7a0cf0c64bde6/omnix-0.3.6-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9ce1ec945465d42e57b9f8155221db1aef7c54bed5e849a805b51cbe43f9b168",
"md5": "db2d4da615a0d968ee256814c7ba75ec",
"sha256": "756cf6c1b2f896c9dbd039dc64729fafb73f6a66e7cba325b6569b4981f4a2ed"
},
"downloads": -1,
"filename": "omnix-0.3.6.tar.gz",
"has_sig": false,
"md5_digest": "db2d4da615a0d968ee256814c7ba75ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 54522,
"upload_time": "2024-04-05T22:12:26",
"upload_time_iso_8601": "2024-04-05T22:12:26.790631Z",
"url": "https://files.pythonhosted.org/packages/9c/e1/ec945465d42e57b9f8155221db1aef7c54bed5e849a805b51cbe43f9b168/omnix-0.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 22:12:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "omnix"
}
JSON