skyport 0.1.0

Skyport is a cli for obtaining information from astronomical objects.

Always looking at the sky.

Skyport

Skyport is a CLI for obtaining information from astronomical objects.

So far, the entire CLI is based on NASA's open APIs for getting images and information available.

---

Documentation: https://skyport.henriquesebastiao.com

Source Code: https://github.com/henriquesebastiao/skyport

---

How to install the CLI

To install the cli, I recommend using pipx:

pipx install skyport

But anyway, this is just a recommendation. You can also install using the manager you prefer. Like pip:

pip install skyport

How to use?

APOD

Requesting the current day's image

You can call APOD (Astronomical Image of the Day) through the command line. Example:

skyport apod

This was the image of the day on the date January 21, 2024. Which was when this part of the documentation was written 😅

Requesting an image from a specific day

skyport apod -d 2022-01-01

More information about the CLI

You can get more information as stated below, however it is interesting to read the complete tutorial to learn skyport superpowers :grin:.

To discover other options, you can use the --help flag:

$ skyport --help

Usage: skyport [OPTIONS] COMMAND [ARGS]...                                   
                                                                             
Skyport is a CLI for obtaining information from astronomical objects.        
                                                                             
╭─ Options ─────────────────────────────────────────────────────────────────╮
│ --version             -v        Returns the version of Skyport            │
│ --help                          Show this message and exit.               │
╰───────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────╮
│ apod   Astronomy Picture of the Day (APOD) https://apod.nasa.gov/apod/    │
╰───────────────────────────────────────────────────────────────────────────╯

More information about subcommands

You can also get information about subcommands by calling the desired subcommand with the --help flag:

$ skyport apod --help

Usage: skyport apod [OPTIONS]                                                
                                                                             
Astronomy Picture of the Day (APOD) https://apod.nasa.gov/apod/             
                                                                             
╭─ Options ─────────────────────────────────────────────────────────────────╮
│ --date        -d      TEXT  Date to search for the image of the day       │
│                             [default: 2024-01-22]                         │
│ --save-image  -s            Download the image                            │
│ --remaining   -r            Tells how many requests remain for the API    │
│ --help                      Show this message and exit.                   │
╰───────────────────────────────────────────────────────────────────────────╯