Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

RisingOS API [v1.1.0]

A RESTful API made using FASTAPI written in Python(v3.11 and above) service that provides OTA (Over-The-Air) update information for RisingOS ROM. This API fetches and serves data from the RisingOTA repository, making it easy to access device-specific ROM information programmatically.

TODO List

  • Endpoints rename to API naming convention
  • Project Restructure with separate concerns (routes, services, models)

Features

  • RESTful endpoints for accessing ROM information
  • Real-time data synchronization with RisingOTA repository
  • Cached responses for improved performance
  • Comprehensive device and build information
  • JSON response format
  • Using concurreny to improve fetching time
  • Authentication using GitHub API

Prerequisites

  • fastapi[standard]>=0.112.0
  • requests
  • pydantic
  • apscheduler
  • git
  • pygithub
  • python-dotenv

API Documentation

you can access:

API Endpoints

  1. API status
GET /
  1. DeviceList
GET /api/v1/device/deviceList
  1. Device Variants and Information
GET /api/v1/device/{codename}

example: /device/lynx, /device/cancunf, etc.

Project Structure

β”œβ”€β”€ main.py
└── ROSAPI
β”‚   β”œβ”€β”€ functions
β”‚   β”‚Β Β  β”œβ”€β”€ DeviceList.py
β”‚   β”‚Β Β  └── DeviceVaraints.py
β”‚   β”œβ”€β”€ __init__.py
β”‚   └── Models
β”‚       β”œβ”€β”€ DnListModel.py
β”‚       └── __init__.py
β”‚
β”œβ”€β”€ README.md
β”œβ”€β”€ requirements.txt

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages