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.0.3.tar.gz (14.3 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.3-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: time_series_profiler-1.0.3.tar.gz
  • Upload date:
  • Size: 14.3 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.3.tar.gz
Algorithm Hash digest
SHA256 ac59c861094cfdeb867c012e092b97ec26916ed0a5afc216087eed7d412dc682
MD5 fa69a4e9e43670fe4701a27af6fcbf4f
BLAKE2b-256 82caa0118cce27f8e3fa6af91457b95daae69a48086d3db050367575db48a2e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for time_series_profiler-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 77b85c911515ac17d178ee808cafded448bb685837363b77ae3acb99ba656e09
MD5 6ab4836c6310c9d847de3a1d8e1ac189
BLAKE2b-256 10824894197225311a4e4a8bc692607104f0a8706bd41de00fa35a60c83ebde1

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