pywib 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pywib
3
- Version: 0.1.0
3
+ Version: 0.1.2
4
4
  Summary: HCI Web Interaction Analyzer - A library for analyzing web user interactions
5
5
  Project-URL: Homepage, https://github.com/HumanCommunicationInteraction/pywib
6
6
  Project-URL: Bug Tracker, https://github.com/HumanCommunicationInteraction/pywib/issues
@@ -31,5 +31,31 @@ Description-Content-Type: text/markdown
31
31
  Pywib (Python Web Interaction Behaviour) is a library desgined for analysing and obtaning metrics from users interaction with web pages.
32
32
 
33
33
  ## How to
34
+ ```python
35
+ from pywib import velocity, velocity_metrics
34
36
 
35
- ```
37
+ v = velocity(df_all_sessions)
38
+ v_metrics = velocity_metrics(None, v)
39
+ ```
40
+
41
+ ## Running the tests
42
+ First, navigate to the pywib folder
43
+ ```bash
44
+ cd pywib
45
+ ```
46
+
47
+ Then install the required dependencies using python, use a virtual environment if you wish to.
48
+ ```python
49
+ pip install pytest
50
+ pip install -r requirements.txt
51
+ ```
52
+ Then, run the tests using:
53
+ ```python
54
+ pytest test
55
+ ```
56
+
57
+ ## Generating Documentation
58
+ ```
59
+ cd pywib/docs
60
+ make html
61
+ ```
@@ -0,0 +1,4 @@
1
+ pywib-0.1.2.dist-info/METADATA,sha256=HmJAOq5cYFHJ801ugiaiouM-ZDruOmDSlPTo1bAxihE,1983
2
+ pywib-0.1.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
3
+ pywib-0.1.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
4
+ pywib-0.1.2.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: hatchling 1.27.0
2
+ Generator: hatchling 1.28.0
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
@@ -1,4 +0,0 @@
1
- pywib-0.1.0.dist-info/METADATA,sha256=0caKSsmiZMGcJnrHH2EoNlcIDKoOzhfXeQzkMKA-6no,1505
2
- pywib-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
3
- pywib-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
4
- pywib-0.1.0.dist-info/RECORD,,