Skip to main content

AstroLab: A Space-themed study CLI tool using real NASA data and Google Gemini AI.

Project description

AstroLab 🚀

NASA API Powered

Pivot for the Hack Club Sidequest Challenger. An astronomy/physics study tool that utilizes real NASA data (APOD endpoint) to generate interactive quizzes and flashcards using Google Gemini AI. The perfect tool for studying "between lectures"!

Features

  • astrolab apod: Shows the "Astronomy Picture of the Day" with a detailed explanation.
  • astrolab quiz: Generates an interactive 5-question quiz based on the daily APOD using AI. Includes a Deep Dive mode to learn from your mistakes!
  • astrolab flashcard "<topic>": Creates a thematic flashcard based on space data and automatically saves it to your personal deck.
  • astrolab review: [NOVO] Starts a review session with all the flashcards you have generated and saved.
  • astrolab stats: Displays your study progress history with stylized bar charts in the terminal! Track your performance and accuracy across sessions.

💡 Quick Start (For Reviewers)

AstroLab is now published on PyPI for a frictionless testing experience!

  1. Install the package globally via pip:
pip install astrolab-cli
  1. [OPTIONAL] To use the fully dynamic AI generation, configure your credentials by creating a .env file in your working directory:
NASA_API_KEY=your_key_here
GEMINI_API_KEY=your_key_here

Note: If you don't configure an .env, the system will use a DEMO_KEY for NASA and safely fallback to our Smart Demo Mode for Gemini, pulling rich pre-generated responses from an internal cache.

  1. Explore space with our beautiful interactive menu by running:
astrolab

Architecture and Tech Stack

  • NASA APOD API: Provides the foundational space data.
  • Google Gemini API: Generates and evaluates questions based on space context and creates Deep Dives.
  • Python / Rich: CLI interface with beautiful visual components.
  • Storage: Study history and Flashcard Deck persisted locally via JSON in data/.

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

astrolab_cli-1.0.1.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

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

astrolab_cli-1.0.1-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file astrolab_cli-1.0.1.tar.gz.

File metadata

  • Download URL: astrolab_cli-1.0.1.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for astrolab_cli-1.0.1.tar.gz
Algorithm Hash digest
SHA256 2f560ba94027f61ad68b871df364050d5f442c6edd110495904fd3543b3b459e
MD5 41a35c257565215da47a0342facb1c02
BLAKE2b-256 51546d03d18543974f64229461b7ff2fe9c919792ea9a26246f7da5094e97534

See more details on using hashes here.

Provenance

The following attestation bundles were made for astrolab_cli-1.0.1.tar.gz:

Publisher: ci.yml on EngThi/AstroLab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file astrolab_cli-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: astrolab_cli-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for astrolab_cli-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1f35135df25b512e6fcd3cbe4cb633835c8f54d5de9736ad7924a79dcaef6420
MD5 050e2c75e6a931ce72ff8160fda5b9e8
BLAKE2b-256 e370eb01d731275d2ff5c2407ee24fa1994d5b6e8072aad5442fa6842afb5c8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for astrolab_cli-1.0.1-py3-none-any.whl:

Publisher: ci.yml on EngThi/AstroLab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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