DaniloCeesar / stellarium-fastapi

A basic implementation of Stellarium RemoteControl plugin interface with FastAPI.

Stellarium + FastAPI
_{Stellarium basic commands in your browser.}

A basic implementation of Stellarium RemoteControl plugin interface with FastAPI.

---

📚 Project overview

This project has made use of the Stellarium Astronomy software, a free open source planetarium for your computer.

This repository provides a web interface, made using FastAPI framework, to interact with Stellarium RemoteControl plugin HTTP API.

🛠️ Development & Testing

Requirements

• Git — free and open source distributed version control system.
• Python — easy to learn, powerful programming language.
• pip — package installer for Python packages.
• Stellarium Astronomy — free open source planetarium.
• Stellarium RemoteControl plugin HTTP API — HTTP-based interface to Stellarium, implemented on the server-side.

Build instructions

1. You will need the Stellarium and Stellarium RemoteControl plugin up and running;
2. git clone https://github.com/DaniloCeesar/stellarium-fastapi.git — clone this repository into a new directory;
3. cd stellarium-fastapi — change the current directory to this project source code;
4. cp .env.example .env — generate a new environment file that will contain your project's environment variables;
5. pip install -r requirements.txt — install the dependencies from requirements.txt file into project's folder;
6. uvicorn main:app --reload — run the development server. The URL address and port will be displayed in your terminal.

👥 Attributions

This project is built by developing and using open source technology. We may use third party libraries, code sources, and assets both for production and development processes.

This project has made use of the Stellarium planetarium. Please remember to also cite their paper in your acknowledgment.

⚖️ License

This project is licensed under the GNU General Public License v2.0. See the LICENSE for more information.