# SNEWS Publishing Tool
<img src="docs/custom_logo.png" alt="snews_logo" width="200"/>
[](https://snews-publishing-tools.readthedocs.io/en/latest/?badge=latest)
<br>See the docs at
| | |
| ------------ | ------ |
| **Docs:** | https://snews-publishing-tools.readthedocs.io/en/latest/ |
This packages provides users with a Python API and CLI to **publish observation messages** to SNEWS and **subscribe to receive alerts** from the SNEWS servers.
> Note: Make sure your hop credentials are set up !!<br>
> Follow the instructions in [**Quick Start**](https://snews-publishing-tools.readthedocs.io/en/latest/user/quickstart.html)
| |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Fire-Drills** |
| Also see [this page](https://snews-publishing-tools.readthedocs.io/en/latest/user/firedrills.html) | | |
| `snews_pt` allows for fire-drill mode, currently this is the default option. <br/><br/> Later, it can be adjusted through `firedrill_mode=True/False` arguments in subcription and publication functions, and through `--firedrill/--no-firedrill` flags within the CLI tools. <br/>Make sure you have the correct [permissions](https://my.hop.scimma.org/hopauth/) to publish and subscribe to these firedrill channels. |
## How to Install
### [Installation Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/installation.html)
## How to Publish and Subscribe
### [Publishing Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/publishing_protocols.html)
### [Subscribe Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/subscribing.html)
## Command Line Interface (CLI)
There also exists tools for command line interactions. These are explained in detail here;
### [CLI Tools](https://snews-publishing-tools.readthedocs.io/en/latest/user/command_line_interface.html)
## Remote Commands and More
### [Remote commands](https://snews-publishing-tools.readthedocs.io/en/latest/user/remote_commands.html)
Raw data
{
"_id": null,
"home_page": "https://github.com/SNEWS2/SNEWS_Publishing_Tools",
"name": "snews-pt",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.11",
"maintainer_email": null,
"keywords": "setup, distutils",
"author": "Sebastian Torres-Lara, Melih Kara",
"author_email": "sebastiantorreslara17@gmail.com, karamel.itu@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c5/4d/8b8f5c7dbcb0372202a6217ad2f2a1f5d4ecdb4f0b19a1c0eeb071cceaa7/snews_pt-1.3.4.tar.gz",
"platform": null,
"description": "# SNEWS Publishing Tool\n<img src=\"docs/custom_logo.png\" alt=\"snews_logo\" width=\"200\"/> \n\n[](https://snews-publishing-tools.readthedocs.io/en/latest/?badge=latest)\n\n<br>See the docs at\n\n| | |\n| ------------ | ------ |\n| **Docs:** | https://snews-publishing-tools.readthedocs.io/en/latest/ |\n\nThis packages provides users with a Python API and CLI to **publish observation messages** to SNEWS and **subscribe to receive alerts** from the SNEWS servers.\n\n> Note: Make sure your hop credentials are set up !!<br>\n> Follow the instructions in [**Quick Start**](https://snews-publishing-tools.readthedocs.io/en/latest/user/quickstart.html)\n\n\n| |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| \n| **Fire-Drills** |\n| Also see [this page](https://snews-publishing-tools.readthedocs.io/en/latest/user/firedrills.html) | | |\n| `snews_pt` allows for fire-drill mode, currently this is the default option. <br/><br/> Later, it can be adjusted through `firedrill_mode=True/False` arguments in subcription and publication functions, and through `--firedrill/--no-firedrill` flags within the CLI tools. <br/>Make sure you have the correct [permissions](https://my.hop.scimma.org/hopauth/) to publish and subscribe to these firedrill channels. |\n\n## How to Install\n\n### [Installation Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/installation.html)\n\n## How to Publish and Subscribe\n\n### [Publishing Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/publishing_protocols.html)\n### [Subscribe Guide](https://snews-publishing-tools.readthedocs.io/en/latest/user/subscribing.html)\n\n\n## Command Line Interface (CLI)\nThere also exists tools for command line interactions. These are explained in detail here;\n### [CLI Tools](https://snews-publishing-tools.readthedocs.io/en/latest/user/command_line_interface.html)\n\n## Remote Commands and More\n\n### [Remote commands](https://snews-publishing-tools.readthedocs.io/en/latest/user/remote_commands.html)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "An alert application for observing supernovas.",
"version": "1.3.4",
"project_urls": {
"Homepage": "https://github.com/SNEWS2/SNEWS_Publishing_Tools"
},
"split_keywords": [
"setup",
" distutils"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "096db1e4f88cc1cfa6d85c463492e7981a461e16450971c84de0119a082ad220",
"md5": "4865b87339b7e5ed78cc21c266c67c4a",
"sha256": "f92501f9fe52d02d87a0d8d1015f13d61b21264fee944460e87a0a33c1fff8d0"
},
"downloads": -1,
"filename": "snews_pt-1.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4865b87339b7e5ed78cc21c266c67c4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.11",
"size": 38495,
"upload_time": "2024-05-10T13:29:20",
"upload_time_iso_8601": "2024-05-10T13:29:20.434388Z",
"url": "https://files.pythonhosted.org/packages/09/6d/b1e4f88cc1cfa6d85c463492e7981a461e16450971c84de0119a082ad220/snews_pt-1.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c54d8b8f5c7dbcb0372202a6217ad2f2a1f5d4ecdb4f0b19a1c0eeb071cceaa7",
"md5": "65e6ac31bdbd62f8775c33200553d5fe",
"sha256": "26ded28c2f59ddc7737ce7e55bfbb0013a98f4e78952c9c6724f3dd74e220983"
},
"downloads": -1,
"filename": "snews_pt-1.3.4.tar.gz",
"has_sig": false,
"md5_digest": "65e6ac31bdbd62f8775c33200553d5fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.11",
"size": 823540,
"upload_time": "2024-05-10T13:29:22",
"upload_time_iso_8601": "2024-05-10T13:29:22.478458Z",
"url": "https://files.pythonhosted.org/packages/c5/4d/8b8f5c7dbcb0372202a6217ad2f2a1f5d4ecdb4f0b19a1c0eeb071cceaa7/snews_pt-1.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-10 13:29:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SNEWS2",
"github_project": "SNEWS_Publishing_Tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
"~=",
"8.1"
]
]
},
{
"name": "hop-client",
"specs": [
[
"~=",
"0.9"
]
]
},
{
"name": "inquirer",
"specs": [
[
"~=",
"2.8"
]
]
},
{
"name": "ipython",
"specs": [
[
"~=",
"8.7"
]
]
},
{
"name": "numpy",
"specs": [
[
"~=",
"1.26"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"~=",
"0.19"
]
]
},
{
"name": "setuptools",
"specs": [
[
"~=",
"69.0"
]
]
},
{
"name": "wheel",
"specs": [
[
"~=",
"0.42"
]
]
}
],
"lcname": "snews-pt"
}
JSON
