Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henriquesebastiao/skyport
Skyport is a CLI for obtaining information from astronomical objects, developed with Typer and consuming NASA's public API.
https://github.com/henriquesebastiao/skyport
api api-client astronomy cli nasa requests requests-python rich science space
Last synced: about 1 month ago
JSON representation
Skyport is a CLI for obtaining information from astronomical objects, developed with Typer and consuming NASA's public API.
- Host: GitHub
- URL: https://github.com/henriquesebastiao/skyport
- Owner: henriquesebastiao
- License: other
- Created: 2024-01-20T21:22:46.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-13T13:24:35.000Z (9 months ago)
- Last Synced: 2024-09-15T13:47:45.069Z (3 months ago)
- Topics: api, api-client, astronomy, cli, nasa, requests, requests-python, rich, science, space
- Language: Python
- Homepage: https://skyport.henriquesebastiao.com
- Size: 102 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://skyport.henriquesebastiao.com)
**Source Code:** [https://github.com/henriquesebastiao/skyport](https://github.com/henriquesebastiao/skyport)
---
## How to install the CLI
To install the cli, I recommend using pipx:
```bash
pipx install skyport
```
But anyway, this is just a recommendation. You can also install using the manager you prefer. Like pip:
```bash
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:
```bash
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
```bash
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](tutorial/index.md) to learn skyport superpowers :grin:.
To discover other options, you can use the `--help` flag:
```txt
$ 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:
```txt
$ 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. │
╰───────────────────────────────────────────────────────────────────────────╯
```