imsciences 0.9.5.4__tar.gz → 0.9.5.5__tar.gz

{imsciences-0.9.5.4 → imsciences-0.9.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imsciences
-Version: 0.9.5.4
+Version: 0.9.5.5
 Summary: IMS Data Processing Package
 Author: IMS
 Author-email: cam@im-sciences.com
@@ -35,23 +35,33 @@ 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)
 
 ---
 
+## 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`
@@ -298,8 +308,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 +321,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,18 +338,6 @@ pip install imsciences
 
 ---
 
-## Usage 
-
-```bash
-from imsciences import * 
-ims_proc = dataprocessing()
-ims_geo = geoprocessing()
-ims_pull = datapull()
-ims_vis = datavis()
-```
-
----
-
 ## License
 
 This project is licensed under the MIT License. ![License](https://img.shields.io/badge/license-MIT-blue.svg)

{imsciences-0.9.5.4 → imsciences-0.9.5.5}/README.md

@@ -8,23 +8,33 @@ 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)
 
 ---
 
+## 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`
@@ -271,8 +281,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.
@@ -284,6 +294,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
@@ -296,18 +311,6 @@ pip install imsciences
 
 ---
 
-## Usage 
-
-```bash
-from imsciences import * 
-ims_proc = dataprocessing()
-ims_geo = geoprocessing()
-ims_pull = datapull()
-ims_vis = datavis()
-```
-
----
-
 ## License
 
 This project is licensed under the MIT License. ![License](https://img.shields.io/badge/license-MIT-blue.svg)