Metadata-Version: 2.1
Name: ensuro-analytics
Version: 0.1.3
Summary: Ensuro analytics library
Home-page: https://github.com/ensuro/ensuro_analytics
Author: Ensuro
Author-email: luca@ensuro.co
License: Apache 2.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs==23.1.0
Requires-Dist: cachetools==5.3.2
Requires-Dist: certifi==2023.7.22
Requires-Dist: charset-normalizer==3.3.1
Requires-Dist: contourpy==1.1.1
Requires-Dist: coverage[toml]==7.3.2
Requires-Dist: cycler==0.12.1
Requires-Dist: db-dtypes==1.1.1
Requires-Dist: environs==9.5.0
Requires-Dist: fastjsonschema==2.18.1
Requires-Dist: fonttools==4.43.1
Requires-Dist: google-api-core[grpc]==2.12.0
Requires-Dist: google-auth==2.23.3
Requires-Dist: google-cloud-bigquery==3.12.0
Requires-Dist: google-cloud-core==2.3.3
Requires-Dist: google-crc32c==1.5.0
Requires-Dist: google-resumable-media==2.6.0
Requires-Dist: googleapis-common-protos==1.61.0
Requires-Dist: grpcio==1.59.0
Requires-Dist: grpcio-status==1.59.0
Requires-Dist: idna==3.4
Requires-Dist: iniconfig==2.0.0
Requires-Dist: jsonschema==4.19.1
Requires-Dist: jsonschema-specifications==2023.7.1
Requires-Dist: jupyter-core==5.4.0
Requires-Dist: kiwisolver==1.4.5
Requires-Dist: marshmallow==3.20.1
Requires-Dist: matplotlib==3.8.0
Requires-Dist: mock==5.1.0
Requires-Dist: nbformat==5.9.2
Requires-Dist: numpy==1.26.1
Requires-Dist: packaging==23.2
Requires-Dist: pandas==2.1.1
Requires-Dist: pillow==10.1.0
Requires-Dist: platformdirs==3.11.0
Requires-Dist: plotly==5.18.0
Requires-Dist: pluggy==1.3.0
Requires-Dist: proto-plus==1.22.3
Requires-Dist: protobuf==4.24.4
Requires-Dist: pyarrow==13.0.0
Requires-Dist: pyasn1==0.5.0
Requires-Dist: pyasn1-modules==0.3.0
Requires-Dist: pyparsing==3.1.1
Requires-Dist: pytest==7.4.3
Requires-Dist: pytest-cov==4.1.0
Requires-Dist: python-dateutil==2.8.2
Requires-Dist: python-dotenv==1.0.0
Requires-Dist: pytz==2023.3.post1
Requires-Dist: pyyaml==6.0.1
Requires-Dist: referencing==0.30.2
Requires-Dist: requests==2.31.0
Requires-Dist: rpds-py==0.10.6
Requires-Dist: rsa==4.9
Requires-Dist: six==1.16.0
Requires-Dist: tenacity==8.2.3
Requires-Dist: traitlets==5.12.0
Requires-Dist: tzdata==2023.3
Requires-Dist: urllib3==2.0.7

# Ensuro Analytics Package

## Description

Ensuro's analytics tool suite.

## Modules

`ensuro_analytics`: This module contains the main analytics functions. It is further divided into two sub-modules:
    - `analytics/`: This module functions to compute standard portfolio metrics (`analytics/metrics`), Ensuro's accessors for pandas dataframes (`analytics/dataframe`), and functions to compute portfolio reviews (`analytics/review`),
    - `download/`: This file contains interfaces to download data from Ensuro's API and BigQuery,
    - `visual/`: This file contains functions to setup plotting library according to Ensuro's layout and functions to visualize portfolio metrics.

## Requirements

See the list of requirements in `requirements.txt/`

## Installation

To install the required packages, run the following command:

```
pip install ensuro-analytics
```

## Usage

See the package [notebook](example.ipynb) for the package instructions.

## Contributing

Thank you for your interest in Ensuro! Head over to our [Contributing Guidelines](CONTRIBUTING.md) for instructions on how to sign our Contributors Agreement and get started with
Ensuro!

Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

## Authors

- _Luca Mungo_
- _Ludovico Napoli_

## License

The repository and all contributions are licensed under
[APACHE 2.0](https://www.apache.org/licenses/LICENSE-2.0). Please review our [LICENSE](LICENSE) file.
