Metadata-Version: 2.3
Name: eda_ts
Version: 1.0.0
Summary: An exploratory data analysys (EDA) tool for time series data
License: MIT
Keywords: eda,time series,exploratory data analysis
Author: Hadar Sharvit
Author-email: hadar@urecsys.com
Requires-Python: >=3.11,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: flake8 (>=7.1.1,<8.0.0)
Requires-Dist: numpy (>=2.2.2,<3.0.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: plotly (>=5.24.1,<6.0.0)
Requires-Dist: plotly-resampler (==0.10.0)
Requires-Dist: plotly_express (>=0.4.1,<0.5.0)
Requires-Dist: pytest (>=8.3.4,<9.0.0)
Requires-Dist: streamlit (>=1.41.1,<2.0.0)
Description-Content-Type: text/markdown

# 📘 Urecsys EDA Tool

Welcome to the Urecsys Exploratory Data Analysis (EDA) tools. This toolkit provides various features for analyzing and visualizing your datasets.

## Overview

EDA is a crucial step in the data analysis process that helps you:
- Summarize main characteristics of datasets
- Detect anomalies
- Uncover patterns
- Visualize data relationships
## Getting Started

1. Set up a virtual environment:
```bash
python -m venv .venv
source .venv/bin/activate  
```
> **Tip**: You can also create a virtual environment in VS Code by pressing `Ctrl+Shift+P` (`⌘ + Shift + P` on macOS), typing `Python: Create Environment`, and following the prompts.


2. Install dependencies using Poetry:
```bash
poetry install
```

3. Launch the EDA tool:
```bash
streamlit run 0_📘_EDA.py
```
> **Tip**: You can type `streamlit run 0` and press Tab for auto-completion

4. Once launched, navigate to 🏠Overview in the sidebar

5. Upload your pickle file to begin analysis


## Development

### Adding New EDA Features

New EDA tools should be added under the `eda/pages` directory following this naming convention:

```
<number>_<emoji>_<title>.py
```

Example: `1_📊_overview.py`

This naming pattern ensures proper ordering and visual organization in the Streamlit sidebar.

To create a new EDA page, you can start by copying the `101_📝_Template.py` file. This template provides a basic structure for your new page.

Replace `<number>`, `<emoji>`, and `<title>` with appropriate values for your new page. This will help maintain consistency and organization within the project.

