atelParser

scrape and parse content of ATels posted on The Astronomer’s Telegram website, identify individual objects by name and coordinates.

Documentation for atelParser is hosted by Read the Docs (last stable version and latest version). The code lives on github. Please report any issues you find here.

Features

• Report the latest ATel count

• Download all ATel as raw HTML pages. After a first download, can be run on a regular basis to download only new/missing ATels.

• Parse ATels to extract coordinates and transient source names to indexed MySQL database tables which can then be used in your own projects.

How to cite atelParser

If you use atelParser in your work, please cite using the following BibTeX entry:

@software{
    Young_atelParser,
    author = {Young, David R.},
    doi = {10.5281/zenodo.8037458},
    license = {GPL-3.0-only},
    title = ,
    url = {https://github.com/thespacedoctor/atelParser}
}

Table of Contents

• Installation
  • Development
• Initialisation
  • Modifying the Settings
  • Basic Python Setup
• Latest ATel Count
  • From the Command-Line
  • From Python Code
• Downloading ATels
  • From the Command-Line
  • From Python Code
• Parsing ATels To A Database
  • From the Command-Line
  • From Python Code
• Todo List
• Release Notes

API Reference

Modules

atelParser.commonutils	common tools used throughout package
atelParser.utKit	Unit testing tools

Classes

atelParser.download	Download ATels as Raw HTML files
atelParser.mysql	Import ATel into MySQL database and parse for names and coordinates

Functions

atelParser.mysql.clean_supernova_name

Clean a SN name.

Release Notes

v1.0.2 - May 10, 2022

• Fixed: docs now building

v1.0.1 - January 14, 2021

• Fixed: dependency clash with other packages for pymysql version

v1.0.0 - January 13, 2021

• ENHANCEMENT full documentation

v0.4.0 - May 4, 2020

• Now compatible with Python 3.*

• Fixed: adding requests, pymysql and pandas as dependencies