Merge pull request #2 from tammojan/master

Moving around code, add setup.py

Author: cosmicpudding

.gitignore

@@ -102,3 +102,15 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# PyCharm
+.idea/
+
+# cache
+skycache/
+
+# Don't add fits files
+*.fits
+
+# Temporary files
+results/

results/Skyview_PKS1657-298_DSS.fits Skyview_PKS1657-298_DSS.fits

@@ -0,0 +1,14 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="SkyviewBot",
+    description="Script to download image from SkyView and post it to Slack.",
+    license="MIT License",
+    author="V.A. Moss and T.J. Dijkema",
+    author_email="vmoss.astro@gmail.com",
+    version="1.0.0",
+    packages=find_packages(),
+    entry_points={
+        'console_scripts': ['skyviewbot=skyviewbot.cli:main']
+    }
+)

modules/functions.py

@@ -0,0 +1,9 @@
+"""skyviewbot: a bot for posting skyview images to Slack
+
+The main usage of skyviewbot is through the command-line interface skyviewbot.
+The tool can be used with
+>>> from skyviewbot import skyviewbot
+"""
+
+from .cli import main
+from .functions import skyviewbot, call_skyview, coords_from_name, send_to_slack, plot_fits

setup.py

@@ -0,0 +1,68 @@
+#!/usr/bin/env python
+"""Command-line interface for skyviewbot"""
+
+# ASTERICS-OBELICS Good Coding Practices (skyviewbot.py)
+# V.A. Moss (vmoss.astro@gmail.com), with suggestions from T.J. Dijkema
+
+import sys
+from .functions import skyviewbot
+from argparse import ArgumentParser, RawTextHelpFormatter
+
+
+def main(*function_args):
+    """Command-line interface to skyviewbot
+
+    Args:
+        List[str]: arguments (typically sys.argv[1:])
+
+    Returns:
+        bool: True if succeeded, False if not
+    """
+
+    parser = ArgumentParser(formatter_class=RawTextHelpFormatter)
+    parser.add_argument('field', help="Field, e.g. 'M101'")
+    parser.add_argument('msg', help="Message to accompany the post on Slack")
+    parser.add_argument('-f', '--fits-name',
+                        default=None,
+                        type=str,
+                        action="store",
+                        help='Specify name of a custom fits file to use as input instead of Skyview (default: %(default)s)')
+    parser.add_argument('-i', '--slack-id',
+                        default=None,
+                        type=str,
+                        help='Your Slack ID (default: %(default)s)')
+    parser.add_argument('-s', '--survey',
+                        default='DSS',
+                        type=str,
+                        help="Survey name, e.g. 'DSS' (default: %(default)s)")
+    parser.add_argument('-r', '--radius',
+                        default=1.,
+                        type=float,
+                        help="Radius (default: %(default)s)")
+    parser.add_argument('-c', '--colormap',
+                        default="viridis",
+                        type=str,
+                        help="Colormap (default: %(default)s)")
+    parser.add_argument('-d', '--dry-run',
+                        default=False,
+                        action='store_true',
+                        help='Dry run: make image, do not post to google and slack (default: %(default)s')
+    args = parser.parse_args(*function_args)
+
+    if not args.slack_id:
+        print('You should use your Slack ID before posting!')
+        return False
+
+    retval = skyviewbot(args.slack_id, args.field, args.fits_name, args.msg, args.survey,
+                        args.radius, args.colormap, dry_run=args.dry_run)
+
+    if retval:
+        print("SkyViewBot posted to Slack successfully")
+    else:
+        print("Some error happened in SkyViewBot")
+
+    return retval
+
+
+if __name__ == '__main__':
+    main(sys.argv[1:])