paulinek13 / apod-extended Goto Github PK

⚠️ Please Note: This project is currently in active development and has not yet reached its first full release. There are some features that are still in progress or not yet implemented, and the documentation may be missing information.

The goal of the project is, simply put, to improve APODs. This improvement includes, for example, the ability to add more information, as well as color-based searching and filtering.

ᴛᴏᴘ⇈

• Python (>=3.12) - python.org/downloads
• pip - pip.pypa.io/en/stable/installation
• NASA API Key (optional) - api.nasa.gov

While not mandatory, having a NASA API key allows for increased usage limits. The project's functionality remains the same, but with an API key, you can make more requests to the APOD API and thus use this tool more effectively.

1. Clone the repo

   git clone https://github.com/paulinek13/apod-extended.git

2. Change directory

   cd apod-extended

3. Create virtual environment using venv

   py -m venv env

4. Activate your virtual environment

   call env\Scripts\activate

5. Install all the dependencies

   pip install -r requirements.txt

6. Rename .env.example to .env

7. Optionally change DEMO_KEY to your NASA API key

8. Change the config file config.yml to your preferences and needs

9. Run the program

   py main.py

ᴛᴏᴘ⇈

• Thanks to NASA for providing APOD API
• Special thanks to the open-source community for valuable libraries and tools used in this project:
  • colorama (GitHub, PyPI), extcolors (GitHub, PyPI), Pillow (GitHub, PyPI), python-dotenv (GitHub, PyPI), PyYAML (GitHub, PyPI), requests (GitHub, PyPI), urllib3 (GitHub, PyPI), and more ...
  • For a comprehensive list of project dependencies, please refer to the requirements.txt file.

ᴛᴏᴘ⇈

• Extract color palettes from APOD images.
• Create a list of filterable colors for easy reference.

ᴛᴏᴘ⇈