Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.06 KB

README.md

File metadata and controls

33 lines (27 loc) · 1.06 KB
Raw

AOSiP Updater Backend

Copyright (c) 2017 The LineageOS Project
Copyright (c) 2018-2019 AOSiP

Adding a new device

  1. Add your device to devices.json, sorted alphanumerically by codename. Fields are documented below.
  2. Submit your changes as a pull request.

devices.json

devices.json is an array of objects, each with several fields:

  • codename: The codename of the device - example beryllium
  • device: The full name - example Pocophone F1
  • maintainer: Your name
  • xda: URL to XDA thread of your device

Development set up:

  1. Setup a virtualenv - python3 -m venv ./venv
  2. Activate it - source venv/bin/activate
  3. Install requirements with pip install -r requirements.txt
  4. Configure your environment appropriately - see the beginning of app.py for some variables you may need to modify
  5. Run with ./app.py

Example API Calls:

Obtaining rom list for a device:
GET /<device>/<romtype>
<device> - Codename of device. Example: beryllium
<romtype> - Buildtype of rom. Example: official