Metadata-Version: 1.1
Name: atelParser
Version: 0.3
Summary: A python package and command-line tools to Download Astronomers' Telegrams and parse them to find transient names and coordinates
Home-page: https://github.com/thespacedoctor/atelParser
Author: David Young
Author-email: davidrobertyoung@gmail.com
License: MIT
Download-URL: https://github.com/thespacedoctor/atelParser/archive/v0.3.zip
Description-Content-Type: UNKNOWN
Description: atelParser 
        =========================
        
        .. image:: https://readthedocs.org/projects/atelParser/badge/
            :target: http://atelParser.readthedocs.io/en/latest/?badge
            :alt: Documentation Status
        
        .. image:: https://cdn.rawgit.com/thespacedoctor/atelParser/master/coverage.svg
            :target: https://cdn.rawgit.com/thespacedoctor/atelParser/master/htmlcov/index.html
            :alt: Coverage Status
        
        *A python package and command-line tools for Download Astronomers' Telegrams and parse them to find transient names and coordinates*.
        
        
        
        
        
        Command-Line Usage
        ==================
        
        .. code-block:: bash 
           
            
            Documentation for atelParser can be found here: http://atelParser.readthedocs.org/en/stable
            
            Usage:
                atel init
                atel count [-s <pathToSettingsFile>]
                atel download [-s <pathToSettingsFile>]
                atel [-r] parse [-s <pathToSettingsFile>]
            
            Options:
                init                  setup the atelParser settings file for the first time
                count                 report the total number of atels reported so far
                download              download new and remaining ATel to the atel-directory stated in settings file
                parse                 add the new ATel contents to database and parse for names and coordinates
            
            
                -h, --help            show this help message
                -v, --version         show version
                -s, --settings        the settings file
                -r, --reparse         re-parse all ATel for names and coordinates
            
        
        Documentation
        =============
        
        Documentation for atelParser is hosted by `Read the Docs <http://atelParser.readthedocs.org/en/stable/>`__ (last `stable version <http://atelParser.readthedocs.org/en/stable/>`__ and `latest version <http://atelParser.readthedocs.org/en/latest/>`__).
        
        Installation
        ============
        
        The easiest way to install atelParser is to use ``pip``:
        
        .. code:: bash
        
            pip install atelParser
        
        Or you can clone the `github repo <https://github.com/thespacedoctor/atelParser>`__ and install from a local version of the code:
        
        .. code:: bash
        
            git clone git@github.com:thespacedoctor/atelParser.git
            cd atelParser
            python setup.py install
        
        To upgrade to the latest version of atelParser use the command:
        
        .. code:: bash
        
            pip install atelParser --upgrade
        
        
        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:
        
        .. code:: bash
        
            git clone git@github.com:thespacedoctor/atelParser.git
            cd atelParser
            python setup.py develop
        
        `Pull requests <https://github.com/thespacedoctor/atelParser/pulls>`__
        are welcomed!
        
        Sublime Snippets
        ~~~~~~~~~~~~~~~~
        
        If you use `Sublime Text <https://www.sublimetext.com/>`_ as your code editor, and you're planning to develop your own python code with atelParser, you might find `my Sublime Snippets <https://github.com/thespacedoctor/atelParser-Sublime-Snippets>`_ useful. 
        
        Issues
        ------
        
        Please report any issues
        `here <https://github.com/thespacedoctor/atelParser/issues>`__.
        
        License
        =======
        
        Copyright (c) 2018 David Young
        
        Permission is hereby granted, free of charge, to any person obtaining a
        copy of this software and associated documentation files (the
        "Software"), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:
        
        The above copyright notice and this permission notice shall be included
        in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
        OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
        IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
        CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
        TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
        SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Keywords: astronomy,parse,atel
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Utilities
