neddy ∞
query the Nasa Extra-Galactic (NED) database via the command-line and programmatically.
Documentation for neddy is hosted by Read the Docs ( development version and master version). The code lives on github. Please report any issues you find here.
Features ∞
Installation ∞
The easiest way to install neddy is to use pip (here we show the install inside of a conda environment):
conda create -n neddy python=3.7 pip
conda activate neddy
pip install neddy
Or you can clone the github repo and install from a local version of the code:
git clone git@github.com:thespacedoctor/neddy.git
cd neddy
python setup.py install
To upgrade to the latest version of neddy use the command:
pip install neddy --upgrade
To check installation was successful run neddy -v. This should return the version number of the install.
Development ∞
If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:
git clone git@github.com:thespacedoctor/neddy.git
cd neddy
python setup.py develop
Pull requests are welcomed!
Initialisation ∞
Before using neddy you need to use the init command to generate a user settings file. Running the following creates a yaml settings file in your home folder under ~/.config/neddy/neddy.yaml:
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.
Modifying the Settings ∞
Once created, open the settings file in any text editor and make any modifications needed.
Basic Python Setup ∞
If you plan to use neddy in your own scripts you will first need to parse your settings file and set up logging etc. One quick way to do this is to use the fundamentals package to give you a logger, a settings dictionary and a database connection (if connection details given in settings file):
## SOME BASIC SETUP FOR LOGGING, SETTINGS ETC
from fundamentals import tools
from os.path import expanduser
home = expanduser("~")
settingsFile = home + "/.config/neddy/neddy.yaml"
su = tools(
arguments={"settingsFile": settingsFile},
docString=__doc__,
)
arguments, settings, log, dbConn = su.setup()
Todo List ∞
Todo
nice!
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neddy/checkouts/develop/docs/source/_template_.md, line 1.)
API Reference ∞
Modules ∞
common tools used throughout package |
|
Unit testing tools |
Classes ∞
The worker class for the conesearch module |
|
The worker class for the namesearch module |
A-Z Index ∞
Modules
common tools used throughout package |
|
Unit testing tools |
Classes
The worker class for the conesearch module |
|
The worker class for the namesearch module |
Functions