Skip to main content

ASCII constellation viewer powered by astronomical data.

Project description

SkyCanvas

License: MIT

ASCII constellation viewer powered by astronomical data.

SkyCanvas is a lightweight command-line tool that allows you to explore constellations directly in your terminal. It renders constellations as ASCII art, displays astronomical data, compares different constellations, show currently visible constellations, and allows exporting them into image formats.

No internet connection is required after installation.

Features

  • ASCII constellation rendering
  • Braille based terminal render
  • Constellation information tables
  • Stars and their connections visualised
  • Animated constellation drawing
  • Comparing two constellations side by side
  • Showing visible constellations for tonight
  • Random constellations to discover
  • Export constellation to PNG / JPG / BMP / SVG format
  • Manual
  • Lightweight and quite fast

Installation

Requirements

  • Python 3.10+
  • pip

Install SkyCanvas:

pip install skycanvas

Example:

SkyCanvas Installation

Run:

skycanvas --help

Commands

version

Show SkyCanvas version.

skycanvas version

man

Display the SkyCanvas manual.

skycanvas man

constellation

Display the constellation ASCII art and info table of choice.

skycanvas constellation <name>

SkyCanvas Constellation

constellation --animate

Display animated version of ASCII art, and info table of choice.

skycanvas constellation <name> --animate

SkyCanvas Constellation

compare

Compare two constellations.

skycanvas compare <name1> <name2>

Skycanvas Compare

list

Display the list of available constellations.

skycanvas list

tonight

Display constellations that are visible tonight.

skycanvas tonight

--export

Export the chosen constellation or tonight constellations to an image format.

skycanvas --export crux svg

Available image formats:

  • PNG
  • JPG
  • BMP
  • SVG

Exports are stored in:

~/SkyCanvas/Exports/

rand

Show a randomly choosen constellation.

skycanvas rand

export-help

Display export usage information.

skycanvas export-help

logo

Show a SkyCanvas logo.

skycanvas logo

Data Storage

SkyCanvas does not require any external database.

All constellation data is stored locally inside the tool.

No account or cloud synchronization requited whatsoever.

Supported Constellations

SkyCanvas currently includes many popular constellations:

  • Orion
  • Ursa Major
  • Cassiopeia
  • Scorpius
  • Taurus
  • Gemini
  • Leo
  • Cygnus
  • Lyra
  • Aquila
  • Pegasus
  • Andromeda
  • Canis Major
  • Canis Minor
  • Draco
  • Sagittarius
  • Virgo
  • Aries
  • Capricornus
  • Pisces
  • Ursa Minor
  • Perseus
  • Cepheus
  • Hydra
  • Centaurus
  • Crux
  • Phoenix
  • Libra
  • Aquarius
  • Cancer

Technologies

SkyCanvas is build with:

  • Python
  • Typer
  • Rich
  • Pillow
  • Skyfield

Files

skycanvas/

    - main.py
    - compare.py
    - constellations.py
    - coordinates.py
    - export.py
    - logo.py
    - render.py
    - tonight.py

Development

Clone repository:

git clone https://github.com/aerissdev-dotcom/SkyCanvas.git

Install dependencies:

pip install -r requirements.txt

Run

skycanvas --help

License

MIT License

Author

aeriss-dev

GitHub:

https://github.com/aerissdev-dotcom

Version

0.1.1

Testing and developing OS

SkyCanvas was developed and tested on macOS. The author does not guarantee full compatibility with every operating system.

OS Compatibility

macOS

Fully tested.

Windows

Should work normally with Python installed.

Linux

Should work normally, but terminal rendering might depend on terminal font support.

Conclusion

SkyCanvas is a small terminal-based astronomy project I created to make exploring the constellations simple and enjoyable.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skycanvas-0.1.1.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

skycanvas-0.1.1-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file skycanvas-0.1.1.tar.gz.

File metadata

  • Download URL: skycanvas-0.1.1.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.6

File hashes

Hashes for skycanvas-0.1.1.tar.gz
Algorithm Hash digest
SHA256 951754dc906ee5a7b483847d35206cf51823bfa734e59e9a751f841fc87a415a
MD5 a3af2084884a013a388129377854d322
BLAKE2b-256 2b4c5fd021f789d17d57f53e51c4a66c446c72e76fb026f0df472a4ef133a981

See more details on using hashes here.

File details

Details for the file skycanvas-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: skycanvas-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.6

File hashes

Hashes for skycanvas-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b0fd4170ec27f2e266fdeababc742930d3e075c34c7aaf45e9fb31c4720f2721
MD5 547f9411dcad5e16a81f1c1e0f0ee89e
BLAKE2b-256 9267afe2701be7cfe6e8956a981baff4c88bc786bed562bedab2c23cef6fb457

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page