Skip to main content

A clean adapter-pattern library for profiling time-series data

Project description

Time Series Profiler

PyPI version Python versions CI License

Analyze time-series data structure, gaps, and statistical properties.

Features

  • Basic statistics (mean, std, min, max, percentiles)
  • Gap detection and sampling analysis
  • Categorical column profiling
  • Multi-entity data support
  • JSON and HTML output

Installation

From PyPI (Recommended)

pip install time-series-profiler

From Source

git clone https://github.com/adilsaid/time-series-profiler.git
cd time-series-profiler
pip install -e .

Usage

import pandas as pd
from tsp import ProfileReport, Config

# With DatetimeIndex
df = pd.DataFrame({
    'value': [1.0, 2.5, 3.2, 4.1],
    'category': ['A', 'B', 'A', 'C']
}, index=pd.date_range('2023-01-01', periods=4, freq='1H'))

report = ProfileReport(df, Config())
print(report.to_json())

# With time column and multiple entities
df = pd.read_csv("data.csv", parse_dates=["time"])
config = Config(time_col="time", entity_cols=("user_id",))
report = ProfileReport(df, config)

print(report.to_json())
html_output = report.to_html()

Example

cd examples
python quickstart.py

License

Apache-2.0 - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

time_series_profiler-1.1.0.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

time_series_profiler-1.1.0-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file time_series_profiler-1.1.0.tar.gz.

File metadata

  • Download URL: time_series_profiler-1.1.0.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for time_series_profiler-1.1.0.tar.gz
Algorithm Hash digest
SHA256 74c74b680a08c9d02874dc2a99ece2eefea661d175e5cc6d38229d006f620e9e
MD5 958236db03ec8301bfcc1f86d7564536
BLAKE2b-256 d6cf80d924dc8643154a2bd394c5af983131366fc9dfdb6a06d30e0945679004

See more details on using hashes here.

File details

Details for the file time_series_profiler-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for time_series_profiler-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef4b05eac4f835c6ff6d5c3a6b122c26aeddd664bdbdab8017306009be1ca95a
MD5 f6026393a0c69607b54b1ad018bd37a4
BLAKE2b-256 d24033e42873fbdbc7947e9e960dd945892c391524fd998709f9c626475dd436

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page