Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.2 KB

README.md

File metadata and controls

61 lines (43 loc) · 2.2 KB

Color Palette Generator using NASA's API

streamlit app The application is deployed to this url https://helloerikaaa-apod-colorpalette-srcapp-v15wh4.streamlit.app

🧐 About

Simple project to generate the color palette of the current picture of the APOD (A picture of the day) service using NASA's API to retreive the images. The application is deployed using streamlit.

🔖 Project structure

Project_folder/
|- src/                                # Folder containing all source code
|- img/                                # Folder containing images used in the README file
|- src/api/api_handler.py              # File with code to retreive the image using the NASA's API
|- src/api/color_extractor.py          # Class with necessary code to extract colors from a image
|- src/image/image_handler.py          # Class to handle all image transformations
|- src/consts/                         # Folder containing constanst used inside the project
|- src/consts/consts.py                # File with necessary constants
|- src/consts/paths.py                 # File containing project paths
|- src/app.py                          # Script to execute the streamlit application
|- Makefile                            # Automatize taks through make utility
|- Pipfile                             # Dependencies

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Setup your environement and install project dependencies.

Clone the project repository:

git clone [email protected]:helloerikaaa/mlflow-server.git

Install Depencencies and start environment using Pipenv:

pipenv install
pipenv shell

🔧 Local environment

To run the project locally, it is necessary to use the Makefile, to execute the streamlit use the following command:

make run

🎈 Contributions

To contribute in this project, please setup locally the project following the steps in Getting started section. I use few packages to guarantee high quality code.

✍️ Authors

  • Erika Sánchez Femat (helloerikaaa)