Metadata-Version: 2.1
Name: pytimetk
Version: 0.1.0
Summary: The time series toolkit for Python.
Author: Matt Dancho
Author-email: mdancho@business-science.io
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: holidays (>=0.33,<0.34)
Requires-Dist: matplotlib (>=3.8.0,<4.0.0)
Requires-Dist: pandas (>=2.1.0,<3.0.0)
Requires-Dist: pandas-flavor (>=0.6.0,<0.7.0)
Requires-Dist: plotly (>=5.17.0,<6.0.0)
Requires-Dist: plotnine (>=0.12.3,<0.13.0)
Requires-Dist: statsmodels (>=0.14.0,<0.15.0)
Requires-Dist: tsfeatures (>=0.4.5,<0.5.0)
Description-Content-Type: text/markdown

# pytimetk

> The time series toolkit for Python

This library is currently under development and is not intended for general usage yet. Functionality is experimental until release 0.1.0.

**Please ⭐ us on GitHub (it takes 2-seconds and means a lot).**

# Install Dev Version

```bash
pip install git+https://github.com/business-science/pytimetk.git
```

# Quickstart:

This is a simple code to test the function `summarize_by_time`:

```python
import pytimetk as tk
import pandas as pd

df = tk.datasets.load_dataset('bike_sales_sample')
df['order_date'] = pd.to_datetime(df['order_date'])

df \
    .groupby("category_2") \
    .summarize_by_time(
        date_column='order_date', 
        value_column= 'total_price',
        freq = "MS",
        agg_func = ['mean', 'sum']
    )
```



## Developers (Contributors): Installation

To install `pytimetk` using [Poetry](https://python-poetry.org/), follow these steps:

### 1. Prerequisites

Make sure you have Python 3.9 or later installed on your system.

### 2. Install Poetry

To install Poetry, you can use the [official installer](https://python-poetry.org/docs/#installing-with-the-official-installer)  provided by Poetry. Do not use pip.

### 3. Clone the Repository

Clone the `pytimetk` repository from GitHub:

```bash
git clone https://github.com/business-science/pytimetk
```

### 4. Install Dependencies

Use Poetry to install the package and its dependencies:

```bash
poetry install
```

or you can create a virtualenv with poetry and install the dependencies

```bash
poetry shell
poetry install
```
