# neddy
[](https://zenodo.org/badge/latestdoi/35160792)
<!-- INFO BADGES -->
[](https://pypi.org/project/neddy/)
[](https://pypi.org/project/neddy/)
[](https://anaconda.org/conda-forge/neddy)
[](https://pepy.tech/project/neddy)
[](https://github.com/thespacedoctor/neddy)
<!-- STATUS BADGES -->
[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/neddy/activity?branch=master)
[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/neddy/activity?branch=develop)
[](https://raw.githack.com/thespacedoctor/neddy/master/htmlcov/index.html)
[](https://neddy.readthedocs.io/en/master/)
[](https://github.com/thespacedoctor/neddy/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22+)
*Query the Nasa Extra-Galactic (NED) database via the command-line and programmatically*.
Documentation for neddy is hosted by [Read the Docs](https://neddy.readthedocs.io/en/master/) ([development version](https://neddy.readthedocs.io/en/develop/) and [master version](https://neddy.readthedocs.io/en/master/)). The code lives on [github](https://github.com/thespacedoctor/neddy). Please report any issues you find [here](https://github.com/thespacedoctor/neddy/issues).
## Features
* A command-line suite to query NED for a given source name or via a sky-location conesearch.
* The ability to send multiple name or conesearch queries with a single command.
* Integrate neddy into your own python scripts to build your own workflows.
## Installation
The best way to install or upgrade neddy is to use `conda` to install the package in its own isolated environment, as shown here:
``` bash
conda create -n neddy python=3.9 neddy -c conda-forge
conda activate neddy
```
If you have previously installed neddy, a warning will be issued stating that a conda environment already exists; select 'y' when asked to remove the existing environment.
To check installation was successful run `neddy -v`. This should return the version number of the install.
## Initialisation
Before using neddy you need to use the `init` command to generate a user settings file. Running the following creates a [yaml](https://learnxinyminutes.com/docs/yaml/) settings file in your home folder under `~/.config/neddy/neddy.yaml`:
```bash
neddy init
```
The file is initially populated with neddy's default settings which can be adjusted to your preference.
If at any point the user settings file becomes corrupted or you just want to start afresh, simply trash the `neddy.yaml` file and rerun `neddy init`.
## How to cite neddy
If you use `neddy` in your work, please cite using the following BibTeX entry:
```bibtex
@software{Young_neddy,
author = {Young, David R.},
doi = {10.5281/zenodo.8037633},
license = {GPL-3.0-only},
title = {{neddy}},
url = {https://github.com/thespacedoctor/neddy}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/thespacedoctor/neddy",
"name": "neddy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ned, query, astronomy, conesearch",
"author": "David Young",
"author_email": "davidrobertyoung@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/da/3d/6633ccd70e7b33ab55c728211544483514e8c85bbfa554ed43206262d88e/neddy-0.4.1.tar.gz",
"platform": null,
"description": "# neddy\n\n[](https://zenodo.org/badge/latestdoi/35160792) \n\n<!-- INFO BADGES --> \n\n[](https://pypi.org/project/neddy/)\n[](https://pypi.org/project/neddy/)\n[](https://anaconda.org/conda-forge/neddy)\n[](https://pepy.tech/project/neddy)\n[](https://github.com/thespacedoctor/neddy)\n\n<!-- STATUS BADGES --> \n\n[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/neddy/activity?branch=master)\n[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/neddy/activity?branch=develop)\n[](https://raw.githack.com/thespacedoctor/neddy/master/htmlcov/index.html)\n[](https://neddy.readthedocs.io/en/master/)\n[](https://github.com/thespacedoctor/neddy/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22+)\n\n*Query the Nasa Extra-Galactic (NED) database via the command-line and programmatically*.\n\nDocumentation for neddy is hosted by [Read the Docs](https://neddy.readthedocs.io/en/master/) ([development version](https://neddy.readthedocs.io/en/develop/) and [master version](https://neddy.readthedocs.io/en/master/)). The code lives on [github](https://github.com/thespacedoctor/neddy). Please report any issues you find [here](https://github.com/thespacedoctor/neddy/issues).\n\n## Features\n\n* A command-line suite to query NED for a given source name or via a sky-location conesearch.\n* The ability to send multiple name or conesearch queries with a single command.\n* Integrate neddy into your own python scripts to build your own workflows.\n\n## Installation\n\nThe best way to install or upgrade neddy is to use `conda` to install the package in its own isolated environment, as shown here:\n\n``` bash\nconda create -n neddy python=3.9 neddy -c conda-forge\nconda activate neddy\n```\n\nIf you have previously installed neddy, a warning will be issued stating that a conda environment already exists; select 'y' when asked to remove the existing environment.\n\nTo check installation was successful run `neddy -v`. This should return the version number of the install.\n\n## Initialisation \n\nBefore using neddy you need to use the `init` command to generate a user settings file. Running the following creates a [yaml](https://learnxinyminutes.com/docs/yaml/) settings file in your home folder under `~/.config/neddy/neddy.yaml`:\n\n```bash\nneddy init\n```\n\nThe file is initially populated with neddy's default settings which can be adjusted to your preference.\n\nIf at any point the user settings file becomes corrupted or you just want to start afresh, simply trash the `neddy.yaml` file and rerun `neddy init`.\n\n## How to cite neddy\n\nIf you use `neddy` in your work, please cite using the following BibTeX entry: \n\n```bibtex\n@software{Young_neddy,\n author = {Young, David R.},\n doi = {10.5281/zenodo.8037633},\n license = {GPL-3.0-only},\n title = {{neddy}},\n url = {https://github.com/thespacedoctor/neddy}\n}\n```\n \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Query the Nasa Extra-Galactic (NED) database via the command-line and programmatically",
"version": "0.4.1",
"project_urls": {
"Download": "https://github.com/thespacedoctor/neddy/archive/v0.4.1.zip",
"Homepage": "https://github.com/thespacedoctor/neddy"
},
"split_keywords": [
"ned",
" query",
" astronomy",
" conesearch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e0a8a3b3757af4e7cb54196359951de7ed1c09a5302e80858129ed56e6afdf9c",
"md5": "c4c87deef37493e95b605ccee781e3d5",
"sha256": "20541d2597f8eda6e1f98277bd29b3dc8f25d29341741a9394724804da674d8a"
},
"downloads": -1,
"filename": "neddy-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4c87deef37493e95b605ccee781e3d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 33064,
"upload_time": "2023-09-20T11:24:34",
"upload_time_iso_8601": "2023-09-20T11:24:34.864013Z",
"url": "https://files.pythonhosted.org/packages/e0/a8/a3b3757af4e7cb54196359951de7ed1c09a5302e80858129ed56e6afdf9c/neddy-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da3d6633ccd70e7b33ab55c728211544483514e8c85bbfa554ed43206262d88e",
"md5": "f4eeedb19cdd212e2872f3f6b67a45a6",
"sha256": "414ca082adde63a513eaea7ae5f789bf7903abe6aa13a428092748b00c212041"
},
"downloads": -1,
"filename": "neddy-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "f4eeedb19cdd212e2872f3f6b67a45a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30731,
"upload_time": "2023-09-20T11:24:32",
"upload_time_iso_8601": "2023-09-20T11:24:32.274497Z",
"url": "https://files.pythonhosted.org/packages/da/3d/6633ccd70e7b33ab55c728211544483514e8c85bbfa554ed43206262d88e/neddy-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-20 11:24:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thespacedoctor",
"github_project": "neddy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "neddy"
}
JSON
