Metadata-Version: 2.1
Name: bemserver-api-client
Version: 0.20.0
Summary: BEMServer API client
Home-page: https://github.com/BEMServer/bemserver-api-client
Author: Nobatek/INEF4
Author-email: dfrederique@nobatek.inef4.com
License: AGPLv3+
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Requires-Python: >=3.9
License-File: LICENSE

====================
BEMServer API client
====================

.. image:: https://img.shields.io/pypi/v/bemserver-api-client.svg
    :target: https://pypi.org/project/bemserver-api-client/
    :alt: Latest version

.. image:: https://img.shields.io/pypi/pyversions/bemserver-api-client.svg
    :target: https://pypi.org/project/bemserver-api-client/
    :alt: Python versions

.. image:: https://github.com/BEMServer/bemserver-api-client/actions/workflows/build-release.yaml/badge.svg
    :target: https://github.com/bemserver/bemserver-api-client/actions?query=workflow%3Abuild
    :alt: Build status

.. image:: https://codecov.io/gh/BEMServer/bemserver-api-client/branch/main/graph/badge.svg?token=FA5TO5HUKP
    :target: https://codecov.io/gh/bemserver/bemserver-api-client
    :alt: Code coverage


BEMServer is a free Building Energy Management software platform.

Its purpose is to store data collected in buildings and produce useful information such as performance indicators or alerts.


This package is a client for `BEMServer API <https://github.com/BEMServer/bemserver-api>`_, based on `requests <https://pypi.org/project/requests/>`_.


-----------------------
API client entry points
-----------------------

+----------------------------+-------------------------------------------------------+-----------------------------------------------+
|                                    API resources                                   |             API client entry point            |
+============================+=======================================================+===============================================+
| **General**                | /about/                                               | about                                         |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /users/                                               | users                                         |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /users_by_user_groups/                                | user_by_user_groups                           |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /user_groups/                                         | user_groups                                   |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /user_groups_by_campaigns/                            | user_groups_by_campaigns                      |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /user_groups_by_campaign_scopes/                      | user_groups_by_campaign_scopes                |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /campaigns/                                           | campaigns                                     |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /campaign_scopes/                                     | campaign_scopes                               |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /io/                                                  | io                                            |
+----------------------------+-------------------------------------------------------+-----------------------------------------------+
| **Structural elements**    | /sites/                                               | sites                                         |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /buildings/                                           | buildings                                     |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /storeys/                                             | storeys                                       |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /spaces/                                              | spaces                                        |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /zones/                                               | zones                                         |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /structural_element_properties/                       | structural_element_properties                 |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /site_properties/                                     | site_properties                               |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /site_property_data/                                  | site_property_data                            |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /building_properties/                                 | building_properties                           |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /building_property_data/                              | building_property_data                        |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /storey_properties/                                   | storey_properties                             |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /storey_property_data/                                | storey_property_data                          |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /space_properties/                                    | space_properties                              |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /space_property_data/                                 | space_property_data                           |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /zone_properties/                                     | zone_properties                               |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /zone_property_data/                                  | zone_property_data                            |
+----------------------------+-------------------------------------------------------+-----------------------------------------------+
| **Timeseries**             | /timeseries/                                          | timeseries                                    |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /timeseries_properties/                               | timeseries_properties                         |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /timeseries_property_data/                            | timeseries_property_data                      |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /timeseries_by_sites/                                 | timeseries_by_sites                           |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /timeseries_by_buildings/                             | timeseries_by_buildings                       |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /timeseries_by_storeys/                               | timeseries_by_storeys                         |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /timeseries_by_spaces/                                | timeseries_by_spaces                          |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /timeseries_by_zones/                                 | timeseries_by_zones                           |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /timeseries_by_events/                                | timeseries_by_events                          |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /weather_timeseries_by_sites/                         | weather_ts_by_sites                           |
+----------------------------+-------------------------------------------------------+-----------------------------------------------+
| **Timeseries data**        | /timeseries_data_states/                              | timeseries_datastates                         |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /timeseries_data/                                     | timeseries_data                               |
+----------------------------+-------------------------------------------------------+-----------------------------------------------+
| **Analysis**               | /analysis/                                            | analysis                                      |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /energies/                                            | energies                                      |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /energy_end_uses/                                     | energy_end_uses                               |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /energy_consumption_timeseries_by_sites/              | energy_cons_ts_by_sites                       |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /energy_consumption_timeseries_by_buildings/          | energy_cons_ts_by_buildings                   |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /energy_production_technologies/                      | energy_prod_technologies                      |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /energy_production_timeseries_by_sites/               | energy_prod_ts_by_sites                       |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /energy_production_timeseries_by_buildings/           | energy_prod_ts_by_buildings                   |
+----------------------------+-------------------------------------------------------+-----------------------------------------------+
| **Events and**             | /events/                                              | events                                        |
| **notifications**          +-------------------------------------------------------+-----------------------------------------------+
|                            | /events_by_sites/                                     | event_by_sites                                |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /events_by_buildings/                                 | event_by_buildings                            |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /events_by_storeys/                                   | event_by_storeys                              |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /events_by_spaces/                                    | event_by_spaces                               |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /events_by_zones/                                     | event_by_zones                                |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /event_categories/                                    | event_categories                              |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /event_categories_by_users/                           | event_categories_by_users                     |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /notifications/                                       | notifications                                 |
+----------------------------+-------------------------------------------------------+-----------------------------------------------+
| **Services**               | /st_cleanups_by_campaigns/                            | st_cleanup_by_campaign                        |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /st_cleanups_by_timeseries/                           | st_cleanup_by_timeseries                      |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /st_check_missings_by_campaigns/                      | st_check_missing_by_campaign                  |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /st_check_outliers_by_campaigns/                      | st_check_outlier_by_campaign                  |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /st_download_weather_data_by_sites/                   | st_download_weather_by_site                   |
|                            +-------------------------------------------------------+-----------------------------------------------+
|                            | /st_download_weather_forecast_data_by_sites/          | st_download_weather_forecast_by_site          |
+----------------------------+-------------------------------------------------------+-----------------------------------------------+


