Solaire API

This API is hosted on Render and is accessible at the following address:

• solaire-api-w20a.onrender.com

Description

Solaire API enables you to retrieve information about the UV index and ozone levels for a given location. It's designed to provide accurate and timely environmental data for developers and researchers.

Table of Contents

• Solaire API
  • Description
  • Table of Contents
  • 🎯 Objective of the project
  • 👥 Target audience
  • ⚙️ What this repository includes
  • 🗂️ Repository structure
  • 🚀 Quick start
  • 🐳 Install & execute
  • 🥽 Security
  • 📰 Changelog
  • 🩷 Acknowledgements
    • Environnement
  • 🧪 Project Status
  • 🔒 License
  • 🤝 Contributing
  • 👤 Author

🎯 Objective of the project

The main goal of this project is to provide an easy-to-use API that allows users to access UV index and ozone level data based on geographic coordinates. This can be particularly useful for developers building applications related to weather, health, or environmental monitoring. By offering a simple interface to retrieve this information, we aim to facilitate the integration of environmental data into various applications and services.

👥 Target audience

• Developers building applications that require environmental data
• Health professionals interested in UV exposure and ozone levels
• Researchers in environmental science
• Data scientists interested in environmental data

⚙️ What this repository includes

• .gitignore for macOS configuration
• Core community files:
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • SECURITY.md
  • CHANGELOG.md
  • LICENSE.md
  • ACKNOWLEDGEMENTS.md
• FastAPI application in app/ with:
  • main.py to run the API
  • custom.py for API logic and utilities
  • index.html for the API homepage
• Example Jupyter notebook in notebooks/
• Basic documentation assets in docs/

🗂️ Repository structure

solaire-api/
├── .gitignore
├── docs/
│   └── images/
├── fastapi/
│   ├── app/
│   │   ├── custom.py
│   │   ├── index.html
│   │   └── main.py
│   ├── Dockerfile
│   ├── docker-compose.yml
│   └── requirements.txt
├── notebooks/
│   └── notebooks.ipynb
├── ACKNOWLEDGEMENTS.md
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
└── SECURITY.md

🚀 Quick start

To quickly get started with the Solaire API, you can use Docker to set up and run the application. Follow the installation instructions below to get the API up and running on your local machine. Once the application is running, you can access the API homepage and test it using the provided example request format.

To set up the application, ensure you have Docker installed and follow these steps:

1. Start the application using Docker Compose:

   cd fastapi
   docker compose up

2. Access the API homepage in your browser at:

   http://localhost:80
   

🐳 Install & execute

For use the fastapi/ app:

pip install -r fastapi/requirements.txt
cd fastapi/app
fastapi dev main.py

🥽 Security

• See SECURITY.md for vulnerability reporting guidelines.

📰 Changelog

Track all notable project changes in CHANGELOG.md.

Recommended:

• Follow a consistent format such as Keep a Changelog
• Create an entry for each release
• Include Added, Changed, Fixed, and Removed sections when relevant

🩷 Acknowledgements

• Use ACKNOWLEDGEMENTS.md to credit people, tools, libraries, and communities that helped the project.

Environnement

• Python ≥ 3.13.5
• Dependencies listed in requirements.txt

🧪 Project Status

• 🔬 Statut : experimental
• 🧭 Roadmap : to be defined

🔒 License

• See LICENSE.md.

🤝 Contributing

Contributions are welcome.

• See CONTRIBUTING.md
• Code of conduct available in CODE_OF_CONDUCT.md.

👤 Author

Gauthier Rammault