Metadata-Version: 2.1
Name: coziepy
Version: 0.0.17
Summary: A package for processing and visualizing data collected with the Cozie-Apple app
Author: Mario Frei
Author-email: mario.frei@gmx.net
Project-URL: homepage, https://www.cozie-apple.app/
Project-URL: documentation, https://cozie-apple.app/docs/
Project-URL: repository, https://github.com/cozie-app/coziepy/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: arrow >=1.2.3
Requires-Dist: DateTime >=5.2
Requires-Dist: fastparquet >=2023.7.0
Requires-Dist: influxdb >=5.3.1
Requires-Dist: matplotlib >=3.7.1
Requires-Dist: matplotlib-inline >=0.1.6
Requires-Dist: numpy >=1.22.4
Requires-Dist: packaging >=23.1
Requires-Dist: pandas >=1.5.2
Requires-Dist: plotly >=5.13.0
Requires-Dist: pyarrow >=9.0.0
Requires-Dist: pytz >=2022.7.0
Requires-Dist: requests >=2.27.0
Requires-Dist: seaborn >=0.12.2
Requires-Dist: utm >=0.7.0
Requires-Dist: shapely >=2.0.0
Requires-Dist: geopandas >=0.13.0
Requires-Dist: nbformat >=5.9.2

# CoziePy
CoziePy is a Python package to retrieve, process, and plot data from the [Cozie iOS app](https://github.com/cozie-app/cozie-apple/) for human comfort data collection.

## Features

TBD


## Documentation and tutorials

TBD

## Quick start

1. Installation
   ```sh
   pip install coziepy
   ```

 2. Download Cozie data using the web API and CoziePy
    ```python
    from coziepy import Cozie

    cozie = Cozie()

    df = cozie.load(
      id_experiment = "AppStore",
      participant_list = ['participant_01', 'participant_02'],
      timezone = 'Asia/Singapore',
      api_url='https://m7cy76lxmi.execute-api.ap-southeast-1.amazonaws.com/default/cozie-apple-researcher-read-influx', 
      api_key='XXX' # Please reach out to cozie.app@gmail.com for an API_KEY
    ) 
    df.head()
    ```
  
  3. Plot Cozie data using CoziePy
     ```python
     from coziepy import Cozie

     cp = CoziePlot(df=df, ws_questions=ws_questions)
    
     fig = cp.cohort_survey_count_bar(mode='plotly')
     fig.show()
     ```


## Contribute

We would love you for the contribution to our project, check the [`LICENSE`](https://github.com/cozie-app/coziepy/blob/master/LICENSE) file for more info.

