| Name | atlasapiclient JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | API Client utility package for the ATLAS Transient Server |
| upload_time | 2025-01-22 14:24:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD-3-Clause |
| keywords |
astronomy
atlas api
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
ATLAS API Client
---
[](https://doi.org/10.5281/zenodo.14331062)
This Python client facilitates the use of the ATLAS API.
Some general use cases are shown below - feel free to reach out to request additional documentation or features.
### Pypi
```
pip install --user atlasapiclient
```
### Clone Github
```
git clone git@github.com:HeloiseS/atlasapiclient.git
```
### Configuration
The client requires a config ile that contains the base url of the ATLAS transient web servers and your token for the ATLAS API.
In the directory `atlasapiclient/config_files` you will find the `api_config_template.yaml` file.
1) Copy it **in the same directory** to a file named `api_config_MINE.yaml`. **YES - THE NAME MATTERS**
```
cd atlasapiclient/config_files
cp api_config_template.yaml api_config_MINE.yaml
```
2) Update your token (if you don't have a token see below)
3) Update the url to "https://psweb.mp.qub.ac.uk/sne/atlas4/api/"
#### How do I get a token?
For now, you ask Ken, the wizard in charge the ATLAS transient servers.
Email: k.w.smith@qub.ac.uk
# [Documentation](https://heloises.github.io/atlasapiclient/)
^^^^ Check out the docs for *recipies* and
details on the data structure you'll get back from the API.
# FAQ
* **Can I query by TNS/ZTF name?**:
No. Do a cone search.
* **WHY?**: Because it's too low on our priority list and we don't have the time.
If it's a really big deal for you and you might have working hours to help us with this, get in touch.
* **Can I do a cone search?** :
Not yet. Poke us if we've not done it by February 2025.
* **Why does the API return so much data**?:
Because it'd take forever to refactor and it's low on the priority list.
If it's a big deal for you talk to us, it might bump it further up the to-do list.
# Community Guidelines
### Reporting issues
Feel free to report any API bugs or missing features by opening an Issue
on this repo.
### Seeking support
If you have questions that do not fit in an issue (or we are
taking too long to reply) you can email hfstevance@gmail.com
### Contributing
If you would like to contribute to this project you are welcome to
fork and open a pull request however **we strongly recommend asking
the dev team (via hfstevance@gmail.com) before you start putting
in some work**. It's possible that changes you want to make would
require other changes in our telescope pipelines and if we do not have
the resources to refactor those codes, or if your changes are incompatible
with our other pipelines, we may have to deny what could look like
a very sensible PR.
Raw data
{
"_id": null,
"home_page": null,
"name": "atlasapiclient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "astronomy, ATLAS API",
"author": null,
"author_email": "Heloise Stevance <hfstevance@gmail.com>, Jack Leland <jack.leland@dtc.ox.ac.uk>, Ken Smith <ken.w.smith@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5c/df/1a05090d2f912d5057bed6b644b503b54f9628dfadfec7f911f318b50ce5/atlasapiclient-1.0.0.tar.gz",
"platform": null,
"description": "ATLAS API Client\n--- \n[](https://doi.org/10.5281/zenodo.14331062)\n\nThis Python client facilitates the use of the ATLAS API.\nSome general use cases are shown below - feel free to reach out to request additional documentation or features.\n\n\n### Pypi\n```\npip install --user atlasapiclient\n```\n\n### Clone Github\n```\ngit clone git@github.com:HeloiseS/atlasapiclient.git\n```\n\n### Configuration\nThe client requires a config ile that contains the base url of the ATLAS transient web servers and your token for the ATLAS API.\nIn the directory `atlasapiclient/config_files` you will find the `api_config_template.yaml` file.\n1) Copy it **in the same directory** to a file named `api_config_MINE.yaml`. **YES - THE NAME MATTERS**\n```\ncd atlasapiclient/config_files\ncp api_config_template.yaml api_config_MINE.yaml\n```\n2) Update your token (if you don't have a token see below)\n3) Update the url to \"https://psweb.mp.qub.ac.uk/sne/atlas4/api/\"\n\n#### How do I get a token?\nFor now, you ask Ken, the wizard in charge the ATLAS transient servers. \nEmail: k.w.smith@qub.ac.uk \n\n# [Documentation](https://heloises.github.io/atlasapiclient/)\n\n^^^^ Check out the docs for *recipies* and \ndetails on the data structure you'll get back from the API.\n\n# FAQ\n* **Can I query by TNS/ZTF name?**: \n No. Do a cone search.\n * **WHY?**: Because it's too low on our priority list and we don't have the time. \n If it's a really big deal for you and you might have working hours to help us with this, get in touch. \n* **Can I do a cone search?** :\n Not yet. Poke us if we've not done it by February 2025.\n* **Why does the API return so much data**?: \nBecause it'd take forever to refactor and it's low on the priority list. \nIf it's a big deal for you talk to us, it might bump it further up the to-do list.\n\n# Community Guidelines\n\n### Reporting issues \nFeel free to report any API bugs or missing features by opening an Issue\non this repo. \n\n### Seeking support \n If you have questions that do not fit in an issue (or we are \n taking too long to reply) you can email hfstevance@gmail.com\n\n### Contributing\nIf you would like to contribute to this project you are welcome to\nfork and open a pull request however **we strongly recommend asking\nthe dev team (via hfstevance@gmail.com) before you start putting \nin some work**. It's possible that changes you want to make would \nrequire other changes in our telescope pipelines and if we do not have \nthe resources to refactor those codes, or if your changes are incompatible \nwith our other pipelines, we may have to deny what could look like \na very sensible PR. \n\n\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "API Client utility package for the ATLAS Transient Server",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"astronomy",
" atlas api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1dd2d1bf7d813e483432c65a15be105c3ca77b54379b59a7f5f331b3bb245fb5",
"md5": "9c3f51ad2c4a1dc298247428f72894cb",
"sha256": "053a57ec88a37cbbd2b496be4fee9c7939db8f7cdac48efe0a3eaebfd203b0b7"
},
"downloads": -1,
"filename": "atlasapiclient-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c3f51ad2c4a1dc298247428f72894cb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10796,
"upload_time": "2025-01-22T14:24:51",
"upload_time_iso_8601": "2025-01-22T14:24:51.875843Z",
"url": "https://files.pythonhosted.org/packages/1d/d2/d1bf7d813e483432c65a15be105c3ca77b54379b59a7f5f331b3bb245fb5/atlasapiclient-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5cdf1a05090d2f912d5057bed6b644b503b54f9628dfadfec7f911f318b50ce5",
"md5": "9ea5a1f527e7ba644445fdc7f11eb23c",
"sha256": "8f190a8a8222f0b314436e1085f6e2d871da36b1abca38fb562bc663d93da278"
},
"downloads": -1,
"filename": "atlasapiclient-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9ea5a1f527e7ba644445fdc7f11eb23c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 93795,
"upload_time": "2025-01-22T14:24:54",
"upload_time_iso_8601": "2025-01-22T14:24:54.351363Z",
"url": "https://files.pythonhosted.org/packages/5c/df/1a05090d2f912d5057bed6b644b503b54f9628dfadfec7f911f318b50ce5/atlasapiclient-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-22 14:24:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "atlasapiclient"
}
