Metadata-Version: 2.4
Name: pywib
Version: 0.1.4
Summary: HCI Web Interaction Analyzer - A library for analyzing web user interactions
Project-URL: Homepage, https://github.com/HumanCommunicationInteraction/pywib
Project-URL: Bug Tracker, https://github.com/HumanCommunicationInteraction/pywib/issues
Project-URL: Documentation, https://pywib.readthedocs.io/
Project-URL: Repository, https://github.com/HumanCommunicationInteraction/pywib.git
Author-email: Guillermo Dylan Carvajal Aza <carvajalguillermo@uniovi.es>, Alejandro Álvarez Varela <avarela@uniovi.es>
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Requires-Dist: matplotlib>=3.5.0
Requires-Dist: numpy>=1.21.0
Requires-Dist: opencv-python>=4.5
Requires-Dist: pandas>=1.3.0
Description-Content-Type: text/markdown

# pywib

Pywib (Python Web Interaction Behaviour) is a library desgined for analysing and obtaning metrics from users interaction with web pages.

## How to
```python
from pywib import velocity, velocity_metrics

v = velocity(df_all_sessions)
v_metrics = velocity_metrics(None, v)
```

## Running the tests
First, navigate to the pywib folder
```bash
cd pywib
```

Then install the required dependencies using python, use a virtual environment if you wish to.
```python
pip install pytest
pip install -r requirements.txt
```
Then, run the tests using:
```python
pytest test
```

## Generating Documentation
```
cd pywib/docs
make html
```
