Alert management API & client
This first release introduces basic operations on the background database, as well as a python API client for easier usage.
Note: pyroclient 0.1.0 mainly requires fastapi, uvicorn and sqlalchemy, while the client only requires requests.
Highlights
Routers
Core API server implementation
New
- Accesses: added basic CRUD (#9, #33, #42, #37)
- Alerts: added basic CRUD (#2, #13, #33), media linking (#20), client routes (#62)
- Devices: added basic CRUD (#2, #13, #10, #23, #33, #37), authentication (#8, #9, #42), ping & location update (#9, #25, #40), and scopes (#44)
- Events: added basic CRUD (#2, #13, #33)
- Installations: added basic CRUD (#2, #13, #33), on-site device listing (#56)
- Login: added token-based login (#8, #10, #9, #33, #37)
- Media: added basic CRUD (#2, #13, #33), alert linking (#20, #62)
- Sites: added basic CRUD (#2, #13, #33), extended fields (#54)
- Users: added basic CRUD (#2, #13, #10, #33, #42), authentication (#8), password update (#15), and scopes (#44)
Database
SQL server running to get persistence over API data
New
Tests
Unittests for the core API
New
Services
Third-party services enabled in the API
New
Documentation
The documentation of the API server
New
- Added OpenAPI automatic documentation build (#2, #19, #38, #41, #52)
- Updated README & CONTRIBUTING (#2, #3, #12, #22)
Client
The python client package for easier usage of the API
New
- Created a Python client for device interactions (#43), and web-platform interactions (#62)
- Added sphinx-built documentation (#48)
Others
New