| Name | skyport JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | Skyport is a cli for obtaining information from astronomical objects. |
| upload_time | 2024-01-23 03:30:58 |
| maintainer | |
| docs_url | None |
| author | Henrique Sebastião |
| requires_python | >=3.11,<4.0 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="docs/assets/skyport-slogan-white.svg" alt="Preview" width="400"/>
</p>
<p align="center"><i>Always looking at the sky.</i></p>
<p align="center">
<a href="https://github.com/henriquesebastiao/skyport/actions/workflows/ci.yml">
<img src="https://github.com/henriquesebastiao/skyport/actions/workflows/ci.yml/badge.svg" alt="CI status"/>
</a>
<a href="https://codecov.io/gh/henriquesebastiao/skyport" >
<img src="https://codecov.io/gh/henriquesebastiao/skyport/graph/badge.svg?token=EG2ZrqIKiH" alt="Codecov status"/>
</a>
<a href="https://github.com/henriquesebastiao/skyport/blob/main/LICENSE">
<img alt="LICENSE" src="https://img.shields.io/badge/license-BEER_WARE-red"/>
</a>
</p>
# 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. │
╰───────────────────────────────────────────────────────────────────────────╯
```
Raw data
{
"_id": null,
"home_page": "",
"name": "skyport",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Henrique Sebasti\u00e3o",
"author_email": "contato@henriquesebastiao.com",
"download_url": "https://files.pythonhosted.org/packages/e6/45/857f9dc6221f5f9e429d33df406a983e226d86440fb3f7ecf5116de20288/skyport-0.1.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"docs/assets/skyport-slogan-white.svg\" alt=\"Preview\" width=\"400\"/>\n</p>\n\n<p align=\"center\"><i>Always looking at the sky.</i></p>\n\n<p align=\"center\">\n <a href=\"https://github.com/henriquesebastiao/skyport/actions/workflows/ci.yml\">\n <img src=\"https://github.com/henriquesebastiao/skyport/actions/workflows/ci.yml/badge.svg\" alt=\"CI status\"/>\n </a>\n <a href=\"https://codecov.io/gh/henriquesebastiao/skyport\" > \n <img src=\"https://codecov.io/gh/henriquesebastiao/skyport/graph/badge.svg?token=EG2ZrqIKiH\" alt=\"Codecov status\"/> \n </a>\n <a href=\"https://github.com/henriquesebastiao/skyport/blob/main/LICENSE\">\n <img alt=\"LICENSE\" src=\"https://img.shields.io/badge/license-BEER_WARE-red\"/>\n </a>\n</p>\n\n# Skyport\n\nSkyport is a CLI for obtaining information from astronomical objects.\n\nSo far, the entire CLI is based on NASA's open APIs for getting images and information available.\n\n---\n\n**Documentation:** [https://skyport.henriquesebastiao.com](https://skyport.henriquesebastiao.com)\n\n**Source Code:** [https://github.com/henriquesebastiao/skyport](https://github.com/henriquesebastiao/skyport)\n\n---\n\n## How to install the CLI\n\nTo install the cli, I recommend using pipx:\n\n```bash\npipx install skyport\n```\n\nBut anyway, this is just a recommendation. You can also install using the manager you prefer. Like pip:\n\n```bash\npip install skyport\n```\n\n## How to use?\n\n### APOD\n\n#### Requesting the current day's image\n\nYou can call APOD (Astronomical Image of the Day) through the command line. Example:\n\n```bash\nskyport apod\n```\n\n> This was the image of the day on the date January 21, 2024. Which was when this part of the documentation was written \ud83d\ude05\n\n#### Requesting an image from a specific day\n\n```bash\nskyport apod -d 2022-01-01\n```\n\n## More information about the CLI\n\nYou can get more information as stated below, however it is interesting to read the [complete tutorial](tutorial/index.md) to learn skyport superpowers :grin:.\n\nTo discover other options, you can use the `--help` flag:\n\n```txt\n$ skyport --help\n\nUsage: skyport [OPTIONS] COMMAND [ARGS]... \n \nSkyport is a CLI for obtaining information from astronomical objects. \n \n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --version -v Returns the version of Skyport \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 apod Astronomy Picture of the Day (APOD) https://apod.nasa.gov/apod/ \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\n### More information about subcommands\n\nYou can also get information about subcommands by calling the desired subcommand with the `--help` flag:\n\n```txt\n$ skyport apod --help\n\nUsage: skyport apod [OPTIONS] \n \nAstronomy Picture of the Day (APOD) https://apod.nasa.gov/apod/ \n \n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --date -d TEXT Date to search for the image of the day \u2502\n\u2502 [default: 2024-01-22] \u2502\n\u2502 --save-image -s Download the image \u2502\n\u2502 --remaining -r Tells how many requests remain for the API \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```",
"bugtrack_url": null,
"license": "",
"summary": "Skyport is a cli for obtaining information from astronomical objects.",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/henriquesebastiao/skyport/issues",
"Documentation": "https://skyport.henriquesebastiao.com",
"Homepage": "https://skyport.henriquesebastiao.com",
"Repository": "https://github.com/henriquesebastiao/skyport"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87d098e5c355f04208b68ba4eb6ab3826cd0606b8e0564b00215969a218cd6d9",
"md5": "f706c395e828aa6e502b50a853035ea8",
"sha256": "adb1adeb2023aa8a1bd624d920fd5bf85b89073c36094613ba6342ee34481bd5"
},
"downloads": -1,
"filename": "skyport-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f706c395e828aa6e502b50a853035ea8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 5437,
"upload_time": "2024-01-23T03:30:55",
"upload_time_iso_8601": "2024-01-23T03:30:55.710926Z",
"url": "https://files.pythonhosted.org/packages/87/d0/98e5c355f04208b68ba4eb6ab3826cd0606b8e0564b00215969a218cd6d9/skyport-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e645857f9dc6221f5f9e429d33df406a983e226d86440fb3f7ecf5116de20288",
"md5": "b2d3d045ca0a82113a30d65e3e4ae9c8",
"sha256": "1489500a58808e605bc7260241ca166fea565831eb9b3192691f44b052f3f18d"
},
"downloads": -1,
"filename": "skyport-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b2d3d045ca0a82113a30d65e3e4ae9c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 5031,
"upload_time": "2024-01-23T03:30:58",
"upload_time_iso_8601": "2024-01-23T03:30:58.065282Z",
"url": "https://files.pythonhosted.org/packages/e6/45/857f9dc6221f5f9e429d33df406a983e226d86440fb3f7ecf5116de20288/skyport-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-23 03:30:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "henriquesebastiao",
"github_project": "skyport",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "skyport"
}
