| Name | antares-client JSON |
| Version |
1.10.0
JSON |
| download |
| home_page | None |
| Summary | A light-weight client for receiving alerts from ANTARES. |
| upload_time | 2025-08-13 21:48:40 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2020 Association of Universities for Research in Astronomy, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
antares
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# antares-client
A light-weight client for receiving alerts from
[ANTARES](http://antares.noirlab.edu).
ANTARES is an Alert Broker developed by the [NSF NOIRLab](http://noirlab.edu) for ZTF and
LSST.
The client is available for use as a Python library and as a command line tool.
Directions for both use cases follow in the [Usage](#usage) section.
Table of Contents:
* [Installation](#installation)
* [Documentation](#documentation)
* [Upgrading](#upgrading)
* [Troubleshooting](#troubleshooting)
## Installation
The ANTARES client supports Python versions 3.6 and up.
To install:
```bash
$ pip install antares-client
```
To install with kafka to use the StreamingClient:
```bash
$ pip install "antares-client[subscriptions]"
```
Verify the client installed correctly:
```bash
$ antares --version
antares, version v1.1.0
```
## Documentation
Visit the [full documentation](https://nsf-noirlab.gitlab.io/csdc/antares/client) for usage
guides, API reference docs, and more.
## Development
To install the development dependencies
```bash
pip install uv
uv sync --all-groups --all-extras
```
## Troubleshooting
Issues? See the
[documentation](https://nsf-noirlab.gitlab.io/csdc/antares/client/troubleshooting) for
common gotchas and, if you can't find a solution there, please open an issue.
Raw data
{
"_id": null,
"home_page": null,
"name": "antares-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "NSF NOIRLab ANTARES Team <antares@noirlab.edu>",
"keywords": "antares",
"author": null,
"author_email": "NSF NOIRLab ANTARES Team <antares@noirlab.edu>",
"download_url": "https://files.pythonhosted.org/packages/eb/8d/3d74b3032f1e0d59134b9cf07b2da4f530b22f36cbde3d4dc200a5161b68/antares_client-1.10.0.tar.gz",
"platform": null,
"description": "# antares-client\n\nA light-weight client for receiving alerts from\n[ANTARES](http://antares.noirlab.edu).\n\nANTARES is an Alert Broker developed by the [NSF NOIRLab](http://noirlab.edu) for ZTF and\nLSST.\n\nThe client is available for use as a Python library and as a command line tool.\nDirections for both use cases follow in the [Usage](#usage) section.\n\nTable of Contents:\n* [Installation](#installation)\n* [Documentation](#documentation)\n* [Upgrading](#upgrading)\n* [Troubleshooting](#troubleshooting)\n\n## Installation\n\nThe ANTARES client supports Python versions 3.6 and up.\n\nTo install:\n\n```bash\n$ pip install antares-client\n```\n\nTo install with kafka to use the StreamingClient:\n\n```bash\n$ pip install \"antares-client[subscriptions]\"\n```\n\nVerify the client installed correctly:\n\n```bash\n$ antares --version\nantares, version v1.1.0\n```\n\n## Documentation\n\nVisit the [full documentation](https://nsf-noirlab.gitlab.io/csdc/antares/client) for usage\nguides, API reference docs, and more.\n\n## Development\n\nTo install the development dependencies\n```bash\npip install uv\nuv sync --all-groups --all-extras\n```\n\n## Troubleshooting\n\nIssues? See the\n[documentation](https://nsf-noirlab.gitlab.io/csdc/antares/client/troubleshooting) for\ncommon gotchas and, if you can't find a solution there, please open an issue.\n\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2020 Association of Universities for Research in Astronomy, Inc.\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "A light-weight client for receiving alerts from ANTARES.",
"version": "1.10.0",
"project_urls": {
"Bug Reports": "https://gitlab.com/nsf-noirlab/csdc/antares/client/-/issues",
"Documentation": "https://nsf-noirlab.gitlab.io/csdc/antares/client",
"Homepage": "https://gitlab.com/nsf-noirlab/csdc/antares/client",
"Source": "https://gitlab.com/nsf-noirlab/csdc/antares/client"
},
"split_keywords": [
"antares"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "10bec2e00bb8eb3d5c27b37ca38c81e55d2825958cfd31b32972759a2dd59158",
"md5": "b5d8285af29126ddefbdd3cbb116c1f9",
"sha256": "476df039bb04618f119a0986d5b5b82afeba745e54aa1007d8d1178b058fe826"
},
"downloads": -1,
"filename": "antares_client-1.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5d8285af29126ddefbdd3cbb116c1f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 17899,
"upload_time": "2025-08-13T21:48:39",
"upload_time_iso_8601": "2025-08-13T21:48:39.635190Z",
"url": "https://files.pythonhosted.org/packages/10/be/c2e00bb8eb3d5c27b37ca38c81e55d2825958cfd31b32972759a2dd59158/antares_client-1.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "eb8d3d74b3032f1e0d59134b9cf07b2da4f530b22f36cbde3d4dc200a5161b68",
"md5": "847e6e9162162fad76bdc3314717d2ab",
"sha256": "c609cac80d2899949d69a0d779b24479dc47e18b5eecba5882edf3bab947ea56"
},
"downloads": -1,
"filename": "antares_client-1.10.0.tar.gz",
"has_sig": false,
"md5_digest": "847e6e9162162fad76bdc3314717d2ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14344,
"upload_time": "2025-08-13T21:48:40",
"upload_time_iso_8601": "2025-08-13T21:48:40.578953Z",
"url": "https://files.pythonhosted.org/packages/eb/8d/3d74b3032f1e0d59134b9cf07b2da4f530b22f36cbde3d4dc200a5161b68/antares_client-1.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-13 21:48:40",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "nsf-noirlab",
"gitlab_project": "csdc",
"lcname": "antares-client"
}
