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

Profile time-series data to understand structure, gaps, and statistical properties.

Features

  • Basic statistics (mean, std, min, max, percentiles)
  • Gap detection and sampling analysis
  • Categorical column profiling
  • Multi-entity/user 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.0.2.tar.gz (14.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.0.2-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: time_series_profiler-1.0.2.tar.gz
  • Upload date:
  • Size: 14.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.0.2.tar.gz
Algorithm Hash digest
SHA256 192bb3ba003276db9144388d852f58f330eed32565111cd34efef130a323bddf
MD5 6c9251aca4a4004ced658042a279a829
BLAKE2b-256 458ae93656d73591c82e2b5070c877d71783822cd32b29308b24f76dbb4a1de1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for time_series_profiler-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 55a37e73540c8fcc1986b731f001505a770041e67c6beba705ebdfa920abe014
MD5 3761d70ceeabaae60fce2a9e1eacab4d
BLAKE2b-256 0d36489a3783260a56037297991d6d03d557d533cc0ce24512eeff96d36fbb55

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