Skip to main content

Python profiling library with block-level profiling and multi-track organization

Project description

Stichotrope

⚠️ Development Status: This repository is currently in the setup phase. The library is not yet available for use.

A Python profiling library for deterministic function and block-level profiling.

Overview

Stichotrope aims to provide a native Python equivalent of CppProfiler, offering:

  • Block-level profiling: Fills the gap between function-level and line-level profiling
  • Multi-track organization: Logical grouping of profiling data
  • Explicit instrumentation: Decorators and context managers for precise control
  • Deterministic profiling: Predictable, reproducible performance measurements

Project Status

🚧 In Development - Phase 1: Infrastructure Foundation

This project is actively being developed following a structured roadmap toward v1.0.0. Current focus:

  • ✅ Testing framework and performance baseline
  • ✅ CI/CD pipeline
  • 🔄 PyPI packaging setup
  • ⏳ Documentation infrastructure
  • ⏳ Thread-safe architecture
  • ⏳ Configuration system
  • ⏳ Production features

Planned Features

  • Thread-safe profiling for multi-threaded applications
  • TOML-based configuration system
  • CSV/JSON export (CppProfiler-compatible)
  • Statistical benchmarking with confidence intervals
  • Cross-platform support (Windows, Linux, macOS)
  • Python 3.9-3.12 support

Installation

Not yet available on PyPI

Once released, installation will be:

pip install stichotrope

Quick Start

Coming soon - The library is not yet ready for use.

Example usage (planned):

from stichotrope import Profiler

profiler = Profiler("MyApp")

@profiler.track(0, "process_data")
def process_data(data):
    return transform(data)

def complex_function():
    with profiler.block(1, "database_query"):
        result = query_database()
    return result

Documentation

Documentation will be available at Read the Docs once the project reaches a stable release.

Development

This project follows a milestone-based development workflow with strict quality gates. See the roadmap for detailed planning.

Contributing

Contributions are welcome once the project reaches v1.0.0. For now, development is focused on establishing the core infrastructure and architecture.

License

This project is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later).

Links


Target Release: v1.0.0 (7-9 weeks from project start)
Current Version: 0.0.0 (development)

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

stichotrope-0.1.0.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

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

stichotrope-0.1.0-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file stichotrope-0.1.0.tar.gz.

File metadata

  • Download URL: stichotrope-0.1.0.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for stichotrope-0.1.0.tar.gz
Algorithm Hash digest
SHA256 977629ec6eef351857be14dae227781f15a349a2f8e4026c4e79682f73bbb5a9
MD5 c13ea7825d0a1734bcf8ce591b746108
BLAKE2b-256 01831c24dd716db29a13774b92f425ce60484102681ce16b1d3053812e227491

See more details on using hashes here.

Provenance

The following attestation bundles were made for stichotrope-0.1.0.tar.gz:

Publisher: release.yml on LittleCoinCoin/stichotrope

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file stichotrope-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: stichotrope-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for stichotrope-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11ea10abe3b55595d0046f337a98eeb17fb5f04796738c08322c8d1732d57bdf
MD5 5d97646475e0b58d682910eac222011d
BLAKE2b-256 5c18689e663f4bada3a194fb0be341af60757397555135a2b67932d0179a30b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for stichotrope-0.1.0-py3-none-any.whl:

Publisher: release.yml on LittleCoinCoin/stichotrope

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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