pyro-api - v0.1.2: Stabilized API for production services Latest Release

Published by frgfm over 2 years ago

This patch release stabilizes the package environment & the tables for production.

Note: the backend mainly requires FastAPI 0.78.0, while the client only requires requests.

Highlights

⚙️ Package management

For development purposes, it is normal to have loose version specifiers. However for production, each version update needs to be inspected carefully. For this reason, we transitioned from loose requirements.txt version specifiers to Poetry (#198).

Poetry is a package management tool that will "lock" our dependencies to a fixed environment by resolving all parent packages. This produces a poetry.lock file that has fixed versions, which can be inspected by the Dependabot for security alerts.

🎨 Client documentation

For clarity, the previous documentation of the API client was changed from Read the Docs to Furo (#193).

This also comes with new features: dark mode, edit button, etc.

🎼 Code quality

Significant improvements to the codebase have been made in this release (#189, #193):

quality tools: added isort, mypy and black
test tools: switched from unittests to pytest
contribution tools: added Makefile
other: added header verification, and PR label verification

✨ New tables & routes

Routes

devices: get_my_device, update_device_hash (#151)
events: fetch_past_events (#116)
sites: create_noalert_site (#130)

Tables

alerts: added azimuth (#129)
devices: added angle_of_view (#134) software_hash (#137)
events: added is_acknowledged (#170)
groups: created (#137)
installation: added is_trustworth (#127)
sites: added "no_alert" as possible value of type (#130)
webhooks: created (#152)

Breaking changes

Deprecated routes

The following routes were deprecated:

alerts: update_alert, link_media (#208)
media: update_media (#208)

Table modifications

The following tables were modified:

alerts: removed type (#142), is_acknowledged (#170), made device_id & media_id mandatory and non-nullable (#208)
accesses: made group_id mandatory (#153)
devices: modified value range of yaw (#185)
installation: removed lat, lon, elevation, yaw, pitch (#143)

What's Changed

Breaking Changes 🛠

refactored: Removed alert type field by @frgfm in https://github.com/pyronear/pyro-api/pull/142
refactor: Removed location fields from the installation table by @frgfm in https://github.com/pyronear/pyro-api/pull/143
refactor: Make group_id mandatory by @florianriche in https://github.com/pyronear/pyro-api/pull/153
refactor: Moved is_acknowledged from alert to event table by @frgfm in https://github.com/pyronear/pyro-api/pull/170
refactor: Moved azimuth angle from (-180, +180) to (0, 360) by @frgfm in https://github.com/pyronear/pyro-api/pull/185
feat: Added max request response size for fetch routes by @frgfm in https://github.com/pyronear/pyro-api/pull/190
fix: Fixed route update mechanism by @frgfm in https://github.com/pyronear/pyro-api/pull/208

New Features 🚀

chore: Updated license from GPLv3 to Apache 2.0 by @frgfm in https://github.com/pyronear/pyro-api/pull/111
feat: Added route to fetch past fires by @frgfm in https://github.com/pyronear/pyro-api/pull/116
feat: Added is_trustworthy boolean field to installation table by @frgfm in https://github.com/pyronear/pyro-api/pull/127
feat: Added azimuth float field to alert table by @frgfm in https://github.com/pyronear/pyro-api/pull/129
feat: Added no_alert type to Sites by @frgfm in https://github.com/pyronear/pyro-api/pull/130
[Client][Site] add no alert site in client by @florianriche in https://github.com/pyronear/pyro-api/pull/133
feat: Added angle_of_view to the device table by @frgfm in https://github.com/pyronear/pyro-api/pull/134
Database migration with alembic by @jean-pasquier in https://github.com/pyronear/pyro-api/pull/112
feat: add group object by @florianriche in https://github.com/pyronear/pyro-api/pull/137
feat: Added event existence check upon alert creation by @frgfm in https://github.com/pyronear/pyro-api/pull/149
feat: Added webhook system and alert notifications to third-parties by @frgfm in https://github.com/pyronear/pyro-api/pull/152
feat: Added software_hash for device update check by @frgfm in https://github.com/pyronear/pyro-api/pull/151
chore: Added a job to push docker to DockerHub by @frgfm in https://github.com/pyronear/pyro-api/pull/155
feat: Added nginx configuration in docker orchestration by @frgfm in https://github.com/pyronear/pyro-api/pull/174
Code of conduct by @fe51 in https://github.com/pyronear/pyro-api/pull/188

Bug Fixes 🐛

fix: Fixed end-to-end script by @frgfm in https://github.com/pyronear/pyro-api/pull/135
chore: Upgraded Python to 3.7 by @florianriche in https://github.com/pyronear/pyro-api/pull/159
fix: Revert "Refactor: Use SQLAlchemy models instead of Table Declaration" by @florianriche in https://github.com/pyronear/pyro-api/pull/160
fix: Fixed Heroku runtime and SQLAlchemy specs by @frgfm in https://github.com/pyronear/pyro-api/pull/161
feat: add default group_id by @florianriche in https://github.com/pyronear/pyro-api/pull/164
[Sites] Fix noAlertSite route creation with default group_id by @florianriche in https://github.com/pyronear/pyro-api/pull/165
[groups] Add group logic to fetching routes by @florianriche in https://github.com/pyronear/pyro-api/pull/166
docs: Fixed client docstring examples by @frgfm in https://github.com/pyronear/pyro-api/pull/173
fix: Fixed client header refresh by @frgfm in https://github.com/pyronear/pyro-api/pull/181
fix: Fixed media registration inconsistency by @frgfm in https://github.com/pyronear/pyro-api/pull/187
fix: Fixed client package name by @frgfm in https://github.com/pyronear/pyro-api/pull/196
docs: Fixed author entry in pyproject by @frgfm in https://github.com/pyronear/pyro-api/pull/197
docs: Fixed URL of client documentation by @frgfm in https://github.com/pyronear/pyro-api/pull/210

Improvements

Crud refactoring & db transactions by @jean-pasquier in https://github.com/pyronear/pyro-api/pull/90
docs: Added detailed examples in client documentation by @frgfm in https://github.com/pyronear/pyro-api/pull/115
feat: Added admin scopes to alert routes by @frgfm in https://github.com/pyronear/pyro-api/pull/122
feat: Added admin scopes to device routes by @frgfm in https://github.com/pyronear/pyro-api/pull/121
feat: Added admin scopes to installation routes by @frgfm in https://github.com/pyronear/pyro-api/pull/120
feat: Added proper scopes to media routes by @frgfm in https://github.com/pyronear/pyro-api/pull/118
Add security admin scope requirement on accesses routes by @jean-pasquier in https://github.com/pyronear/pyro-api/pull/104
Align devices update by @jean-pasquier in https://github.com/pyronear/pyro-api/pull/113
test: Fixed unittests scoping issues by @frgfm in https://github.com/pyronear/pyro-api/pull/138
refactor: Removed the "me" scope and replace it with "user" by @frgfm in https://github.com/pyronear/pyro-api/pull/141
feat: Added group_id to access table by @frgfm in https://github.com/pyronear/pyro-api/pull/144
feat: add missing link between site and group by @florianriche in https://github.com/pyronear/pyro-api/pull/147
Add function to check for group by @florianriche in https://github.com/pyronear/pyro-api/pull/148
Client: Add azimuth in alerts functions by @florianriche in https://github.com/pyronear/pyro-api/pull/157
Refactor: Use SQLAlchemy models instead of Table Declaration by @florianriche in https://github.com/pyronear/pyro-api/pull/156
Refactor: Use SQLAlchemy models instead of Table Declaration (after fix) by @florianriche in https://github.com/pyronear/pyro-api/pull/162
chore: Reduced python version of the client to 3.6 by @florianriche in https://github.com/pyronear/pyro-api/pull/163
[Groups] Add group logic to remaining routes by @florianriche in https://github.com/pyronear/pyro-api/pull/167
feat: Added console log to notify that Sentry is enabled by @frgfm in https://github.com/pyronear/pyro-api/pull/172
test: Extended client unittests by @frgfm in https://github.com/pyronear/pyro-api/pull/175
fix: Fixed schemas typing by @frgfm in https://github.com/pyronear/pyro-api/pull/178
feat: Added token refresh method to client by @frgfm in https://github.com/pyronear/pyro-api/pull/180
feat: Specified HTTP status code and error messages by @frgfm in https://github.com/pyronear/pyro-api/pull/182
refactor: Cleaned codebase and improve code quality by @frgfm in https://github.com/pyronear/pyro-api/pull/189
ci: Optimized CI cache by @frgfm in https://github.com/pyronear/pyro-api/pull/191
ci: Updated funding from OpenCollective to Github by @frgfm in https://github.com/pyronear/pyro-api/pull/192
refactor: Cleaned docker orchestration and code style by @frgfm in https://github.com/pyronear/pyro-api/pull/193
chore: Pinned versions using poetry by @frgfm in https://github.com/pyronear/pyro-api/pull/198
ci: Removed version update for dependabot by @frgfm in https://github.com/pyronear/pyro-api/pull/206
fix: Fixed media duplication by @frgfm in https://github.com/pyronear/pyro-api/pull/207
docs: Fixes README badge and client documentation by @frgfm in https://github.com/pyronear/pyro-api/pull/209

Full Changelog: https://github.com/pyronear/pyro-api/compare/v0.1.1...v0.1.2

pyro-api - End-to-end API & client support

Published by frgfm almost 4 years ago

This release extends considerably the support of the API by the client, and introduces media upload and download efficiently from cloud storage.

Note: pyroapi 0.1.1 mainly requires fastapi, uvicorn and sqlalchemy, while the client only requires requests.

Highlights

Routers

Core API server implementation
New

Alerts: added alert acknowledgement route (#82)
Devices: added a route to register the user's own device (#80)

Improvements

Alerts: added media existence check (#77), and updated scopes (#99)
Events: updates scopes of existing routes (#59, #99)
Installations: changed method type of device listing route (#72), and updated scopes (#99)
Media: added proper exceptions when upload fails (#96), updated media naming (#98, #100), updated scopes (#99), added integrity check of content transfer (#102)
Sites: updated scopes of existing routes (#58), updated scopes (#99)

Fixes

Events: fixed scope checks in creation and update routes (#85)
Installations: fixed active devices listing route (#69, #81)
Devices: added access deletion (#76), checked login consistency with access table (#83)
Media: fixed upload route (#95)
Users: added access deletion (#76), checked login consistency with access table (#83)

Database

SQL server running to get persistence over API data
New

Added field for acknowledgement state of alerts (#82)

Improvements

Made access login unique (#76)

Tests

Unittests for the core API
New

Added end-to-end script CI job (#89)

Improvements

Added full postgre-SQL DB testing (#68, #70)

Services

Third-party services enabled in the API
New

Added Qarnot storage integration (#87)

Documentation

The documentation of the API server
Improvements

Added route summary and descriptions (#78)

Client

The python client package for easier usage of the API
New

Added integration of event creation, alert & media creation from device, media upload (#77), alert acknowledgement (#93)
Added unittests for client methods (#74)

Improvements

Added typing to all methods (#74)

Fixes

Fixed route mapping of devices (#86)

Others

Separated production and dev requirements (#73)
Added sentry integration (#71)
Added funding option

pyro-api - Alert management API & client

Published by frgfm almost 4 years ago

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)