transientNamer

Python API for reading and caching TNS reports.

Documentation for transientNamer is hosted by Read the Docs (development version and master version). The code lives on github. Please report any issues you find here.

Features

How to cite transientNamer

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

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

Table of Contents

• Installation
  • MySQL
  • Development
• Initialisation
  • Modifying the Settings
  • Basic Python Setup
• Caching and Parsing Astronotes
  • From the Command-Line
  • From Python Script
• Todo List
• Release Notes

API Reference

Modules

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

Classes

transientNamer.astronotes	Tools to download, parse and ingest astronote content into a MySQL database
transientNamer.search	Search the Transient Name Server with various search constraints

Functions

transientNamer.commonutils.getpackagepath

getpackagepath

Release Notes

v0.4.6 - July 3, 2023

• FIXED: small fixes to unit-tests

v0.4.5 - January 10, 2023

• FIXED: changes to search url to reflectv changes made on the TNS. All transients should now be reported again.

v0.4.4 - June 17, 2022

• FIXED: unit-tests failing due to throttling from TNS

v0.4.3 - January 25, 2021

• FIXED: call to settings file now explicit from command-line (was not required until tns-marker added)

v0.4.2 - January 25, 2021

• REFACTOR: requests will fail if TNS responds with any status other than 200

• REFACTOR: added user-agent header now required by TNS (needs added in the settings file)

v0.4.1 - January 25, 2021

• FEATURE:** you can now download and parse astronotes (including ability to add to MySQL database tables)

• REFACTOR: Updated URL to the new TNS URL https://www.wis-tns.org

v0.3.2 - December 21, 2020

• ENHANCEMENT: now using discovered_period_value for discInLastDays. More efficient than adding range of obsdate.

v0.3.1 - October 25, 2020

• FIXED: bytes to string with utf-8 encoding bug stopping regexes from passing

v0.3.0 - May 22, 2020

• Now compatible with Python 3.*