Metadata-Version: 2.4
Name: ensuro-analytics
Version: 0.1.10
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==25.1.0
Requires-Dist: beautifulsoup4==4.13.3
Requires-Dist: cachetools==5.5.2
Requires-Dist: certifi==2025.1.31
Requires-Dist: charset-normalizer==3.4.1
Requires-Dist: contourpy==1.3.1
Requires-Dist: coverage[toml]==7.6.12
Requires-Dist: cycler==0.12.1
Requires-Dist: db-dtypes==1.4.1
Requires-Dist: environs==14.1.1
Requires-Dist: fastjsonschema==2.21.1
Requires-Dist: fonttools==4.56.0
Requires-Dist: frozendict==2.4.6
Requires-Dist: google-api-core[grpc]==2.24.1
Requires-Dist: google-auth==2.38.0
Requires-Dist: google-cloud-bigquery==3.31.0
Requires-Dist: google-cloud-core==2.4.3
Requires-Dist: google-crc32c==1.6.0
Requires-Dist: google-resumable-media==2.7.2
Requires-Dist: googleapis-common-protos==1.69.0
Requires-Dist: grpcio==1.70.0
Requires-Dist: grpcio-status==1.70.0
Requires-Dist: idna==3.10
Requires-Dist: iniconfig==2.0.0
Requires-Dist: jsonschema==4.23.0
Requires-Dist: jsonschema-specifications==2024.10.1
Requires-Dist: jupyter-core==5.7.2
Requires-Dist: kiwisolver==1.4.8
Requires-Dist: marshmallow==3.26.1
Requires-Dist: matplotlib==3.10.1
Requires-Dist: mock==5.2.0
Requires-Dist: multitasking==0.0.11
Requires-Dist: narwhals==1.29.0
Requires-Dist: nbformat==5.10.4
Requires-Dist: numpy==2.2.3
Requires-Dist: packaging==24.2
Requires-Dist: pandas==2.2.3
Requires-Dist: peewee==3.17.9
Requires-Dist: pillow==11.1.0
Requires-Dist: platformdirs==4.3.6
Requires-Dist: plotly==6.0.0
Requires-Dist: pluggy==1.5.0
Requires-Dist: proto-plus==1.26.0
Requires-Dist: protobuf==5.29.3
Requires-Dist: pyarrow==19.0.1
Requires-Dist: pyasn1==0.6.1
Requires-Dist: pyasn1-modules==0.4.1
Requires-Dist: pyparsing==3.2.1
Requires-Dist: pytest==8.3.5
Requires-Dist: pytest-cov==6.0.0
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: python-dotenv==1.0.1
Requires-Dist: pytz==2025.1
Requires-Dist: pyyaml==6.0.2
Requires-Dist: referencing==0.36.2
Requires-Dist: requests==2.32.3
Requires-Dist: rpds-py==0.23.1
Requires-Dist: rsa==4.9
Requires-Dist: six==1.17.0
Requires-Dist: soupsieve==2.6
Requires-Dist: tqdm==4.67.1
Requires-Dist: traitlets==5.14.3
Requires-Dist: typing-extensions==4.12.2
Requires-Dist: tzdata==2025.1
Requires-Dist: urllib3==2.3.0
Requires-Dist: yfinance==0.2.54
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

# 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 submodules:
    - `analytics/`: This module functions to compute standard portfolio metrics (`analytics/portfolio`), Ensuro's accessors for pandas dataframes (`analytics/dataframe`), functions to compute portfolio reviews (`analytics/review`), and functions to compute "financial" etoken metrics (`analytics/etokens`)
    - `download/`: This file contains interfaces to download data from Ensuro's API and BigQuery,
    - `visual/`: This file contains functions to set up plotting libraries 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.
