imsciences 0.9.5.4__py3-none-any.whl → 0.9.5.6__py3-none-any.whl

imsciences/unittesting.py

@@ -3,7 +3,6 @@ import pandas as pd
 import numpy as np
 import os
 from mmm import dataprocessing
-import plotly.graph_objects as go
 
 class TestDataProcessor(unittest.TestCase):
     

{imsciences-0.9.5.4.dist-info → imsciences-0.9.5.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imsciences
-Version: 0.9.5.4
+Version: 0.9.5.6
 Summary: IMS Data Processing Package
 Author: IMS
 Author-email: cam@im-sciences.com
@@ -24,6 +24,7 @@ Requires-Dist: yfinance
 Requires-Dist: holidays
 Requires-Dist: google-analytics-data
 Requires-Dist: geopandas
+Requires-Dist: geopy
 
 # IMS Package Documentation
 
@@ -35,23 +36,34 @@ The **Independent Marketing Sciences** package is a Python library designed to p
 - Seamless data processing for time series workflows.
 - Aggregation, filtering, and transformation of time series data.
 - Visualising Data
-- Integration with external data sources like FRED, Bank of England, ONS and OECD.
+- Integration with external data sources like FRED, Bank of England and ONS.
 
 ---
 
 Table of Contents
 =================
 
-1. [Data Processing for Time Series](#data-processing-for-time-series)
-2. [Data Processing for Incrementality Testing](#data-processing-for-incrementality-testing)
-3. [Data Visualisations](#data-visualisations)
-4. [Data Pulling](#data-pulling)
-5. [Installation](#installation)
-6. [Usage](#usage)
+1. [Usage](#usage)
+2. [Data Processing for Time Series](#data-processing-for-time-series)
+3. [Data Processing for Incrementality Testing](#data-processing-for-incrementality-testing)
+4. [Data Visualisations](#data-visualisations)
+5. [Data Pulling](#data-pulling)
+6. [Installation](#installation)
 7. [License](#license)
+8. [Roadmap](#roadmap)
 
 ---
 
+## Usage 
+
+```bash
+from imsciences import dataprocessing, geoprocessing, datapull, datavis
+ims_proc = dataprocessing()
+ims_geo = geoprocessing()
+ims_pull = datapull()
+ims_vis = datavis()
+```
+
 ## Data Processing for Time Series
 
 ## 1. `get_wd_levels`
@@ -239,14 +251,14 @@ Table of Contents
 - **Example**: `pull_ga('GeoExperiment-31c5f5db2c39.json', '111111111', '2023-10-15', 'United Kingdom', ['totalUsers', 'newUsers'])`
 
 ## 2. `process_itv_analysis`
-- **Description**: Pull in GA4 data for geo experiments.
-- **Usage**: `process_itv_analysis(self, raw_df, itv_path, cities_path, media_spend_path, output_path, group1, group2)`
-- **Example**: `process_itv_analysis(df, 'itv regional mapping.csv', 'Geo_Mappings_with_Coordinates.xlsx', 'IMS.xlsx', 'itv_for_test_analysis_itvx.csv', ['West', 'Westcountry', 'Tyne Tees'], ['Central Scotland', 'North Scotland'])`
+- **Description**: Processes region-level data for geo experiments by mapping ITV regions, grouping selected metrics, merging with media spend data, and saving the result.
+- **Usage**: `process_itv_analysis(self, raw_df, itv_path, cities_path, media_spend_path, output_path, test_group, control_group, columns_to_aggregate, aggregator_list)`
+- **Example**: `process_itv_analysis(df, 'itv regional mapping.csv', 'Geo_Mappings_with_Coordinates.xlsx', 'IMS.xlsx', 'itv_for_test_analysis_itvx.csv', ['West', 'Westcountry', 'Tyne Tees'], ['Central Scotland', 'North Scotland'], ['newUsers', 'transactions'], ['sum', 'sum'])`
 
 ## 3. `process_city_analysis`
-- **Description**: Processes city-level data for geo experiments by grouping user metrics, merging with media spend data, and saving the result.
-- **Usage**: `process_city_analysis(raw_df, spend_df, output_path, group1, group2, response_column)`
-- **Example**: `process_city_analysis(df, spend, output, ['Barnsley'], ['Aberdeen'], 'newUsers')`
+- **Description**: Processes city-level data for geo experiments by grouping selected metrics, merging with media spend data, and saving the result.
+- **Usage**: `process_city_analysis(raw_df, spend_df, output_path, test_group, control_group, columns_to_aggregate, aggregator_list)`
+- **Example**: `process_city_analysis(df, spend, output, ['Barnsley'], ['Aberdeen'], ['newUsers', 'transactions'], ['sum', 'sum'])`
 
 ---
 
@@ -298,8 +310,8 @@ Table of Contents
 
 ## 6. `pull_weather`
 - **Description**: Fetch and process historical weather data for the specified country.
-- **Usage**: `pull_weather(week_commencing, country)`
-- **Example**: `pull_weather('mon', 'GBR')`
+- **Usage**: `pull_weather(week_commencing, start_date, country)`
+- **Example**: `pull_weather('mon', '2020-01-01', 'GBR')`
 
 ## 7. `pull_macro_ons_uk`
 - **Description**: Fetch and process time series data from the Beta ONS API.
@@ -311,6 +323,11 @@ Table of Contents
 - **Usage**: `pull_yfinance(tickers, week_start_day)`
 - **Example**: `pull_yfinance(['^FTMC', '^IXIC'], 'mon')`
 
+## 9. `pull_sports_events`
+- **Description**: Pull a veriety of sports events primaraly football and rugby.
+- **Usage**: `pull_sports_events(start_date, week_commencing)`
+- **Example**: `pull_sports_events('2020-01-01', 'mon')`
+
 ---
 
 ## Installation
@@ -323,20 +340,16 @@ pip install imsciences
 
 ---
 
-## Usage 
+## License
 
-```bash
-from imsciences import * 
-ims_proc = dataprocessing()
-ims_geo = geoprocessing()
-ims_pull = datapull()
-ims_vis = datavis()
-```
+This project is licensed under the MIT License. ![License](https://img.shields.io/badge/license-MIT-blue.svg)
 
 ---
 
-## License
+## Roadmap
 
-This project is licensed under the MIT License. ![License](https://img.shields.io/badge/license-MIT-blue.svg)
+- [Fixes]: Naming conventions are inconsistent/ have changed from previous seasonality tools (eg. 'seas_nyd' is named 'seas_new_years_day', 'week_1' is named 'seas_1')
+- [Fixes]: Naming conventions can be inconsistent within the data pull (suffix on some var is 'gb' on some it is 'uk' and for others there is no suffix) - furthermore, there is a lack of consistency for global holidays/events (Christmas, Easter, Halloween, etc) - some have regional suffix and others don't.
+- [Additions]: Need to add new data pulls for more macro and seasonal varibles
 
 ---

{imsciences-0.9.5.4.dist-info → imsciences-0.9.5.6.dist-info}/RECORD

@@ -5,18 +5,18 @@ imsciences/__init__.py,sha256=_HuYeLbDMTdt7GpKI4r6-d7yRPZgcAQ7yOW0-ydR2Yo,117
 imsciences/datafunctions-IMS-24Ltp-3.py,sha256=3Snv-0iE_03StmyjtT-riOU9f4v8TaJWLoyZLJp6l8Y,141406
 imsciences/datafunctions.py,sha256=WZrXNLO-SYrCuFt0pAbha74psMOZPY7meWJ7yWEbRpk,169953
 imsciences/datapull.py,sha256=TPY0LDgOkcKTBk8OekbD0Grg5x0SomAK2dZ7MuT6X1E,19000
-imsciences/geo.py,sha256=J8AkLk1Nyty3VBkPFqcseXjtlSvXVNkHW_nymERz3nA,13472
+imsciences/geo.py,sha256=-UVQQG8lpUJSos_MjYoKArgPWivD7lFEG5oxF9AGDQg,17526
 imsciences/mmm.py,sha256=w2A90eJPvMH0Mp3jh8booKaLGm0BKFqW-H92FR4OpV8,80490
-imsciences/pull.py,sha256=bGz8B7bBQ5b9hrx3ipCFTWl_eebEb7rPL4dANKiVWTY,74015
-imsciences/unittesting.py,sha256=DYGqVCsZHrs_tZ-EXDW8q8CdlcsTnG8HsnmWjEE521c,45691
+imsciences/pull.py,sha256=8j4k9hnQ9IuxY8W_PvO6afutPm4Pz_SJRjZfU47qxX0,81654
+imsciences/unittesting.py,sha256=U177_Txg0Lqn49zYRu5bl9OVe_X7MkNJ6V_Zd6DHOsU,45656
 imsciences/vis.py,sha256=2izdHQhmWEReerRqIxhY4Ai10VjL7xoUqyWyZC7-2XI,8931
 imsciencesdataprocessing/__init__.py,sha256=quSwsLs6IuLoA5Rzi0ZD40xZaQudwDteF7_ai9JfTPk,32
 imsciencesdataprocessing/datafunctions.py,sha256=vE1vsZ8xOSbR9Bwlp9SWXwEHXQ0nFydwGkvzHXf2f1Y,41
 imsdataprocessing/__init__.py,sha256=quSwsLs6IuLoA5Rzi0ZD40xZaQudwDteF7_ai9JfTPk,32
 imsdataprocessing/datafunctions.py,sha256=vE1vsZ8xOSbR9Bwlp9SWXwEHXQ0nFydwGkvzHXf2f1Y,41
-imsciences-0.9.5.4.dist-info/LICENSE.txt,sha256=lVq2QwcExPX4Kl2DHeEkRrikuItcDB1Pr7yF7FQ8_z8,1108
-imsciences-0.9.5.4.dist-info/METADATA,sha256=wCS5rgCM0s3XEwXIPZCwBpaej5PxebfgHB1MaKy-5us,17644
-imsciences-0.9.5.4.dist-info/PKG-INFO-IMS-24Ltp-3,sha256=yqZbigwHjnYoqyI81PGz_AeofRFfOrwH_Vyawyef-mg,854
-imsciences-0.9.5.4.dist-info/WHEEL,sha256=ixB2d4u7mugx_bCBycvM9OzZ5yD7NmPXFRtKlORZS2Y,91
-imsciences-0.9.5.4.dist-info/top_level.txt,sha256=hsENS-AlDVRh8tQJ6-426iUQlla9bPcGc0-UlFF0_iU,11
-imsciences-0.9.5.4.dist-info/RECORD,,
+imsciences-0.9.5.6.dist-info/LICENSE.txt,sha256=lVq2QwcExPX4Kl2DHeEkRrikuItcDB1Pr7yF7FQ8_z8,1108
+imsciences-0.9.5.6.dist-info/METADATA,sha256=ZGduN0X7DpyEAu3CC1QqZVpQsNITjObWk7Iml-7m5FI,18846
+imsciences-0.9.5.6.dist-info/PKG-INFO-IMS-24Ltp-3,sha256=yqZbigwHjnYoqyI81PGz_AeofRFfOrwH_Vyawyef-mg,854
+imsciences-0.9.5.6.dist-info/WHEEL,sha256=ixB2d4u7mugx_bCBycvM9OzZ5yD7NmPXFRtKlORZS2Y,91
+imsciences-0.9.5.6.dist-info/top_level.txt,sha256=hsENS-AlDVRh8tQJ6-426iUQlla9bPcGc0-UlFF0_iU,11
+imsciences-0.9.5.6.dist-info/RECORD,,