codegreen 0.4.7__tar.gz → 0.4.9__tar.gz

codegreen-0.4.9/MANIFEST.in

@@ -0,0 +1,17 @@
+include README.md LICENSE requirements.txt pyproject.toml CMakeLists.txt setup.py
+include config/codegreen.json
+
+recursive-include codegreen/measurement CMakeLists.txt *.cpp *.c *.h *.hpp
+recursive-include codegreen/instrumentation/language_runtimes *.py *.h *.hpp *.java
+recursive-include codegreen/instrumentation/configs *.json
+include codegreen/config.json
+
+global-exclude *.pyc
+global-exclude __pycache__
+global-exclude *.so
+global-exclude *.dylib
+global-exclude *.dll
+global-exclude *.jar
+global-exclude *.class
+global-exclude .DS_Store
+global-exclude *.o

{codegreen-0.4.7/codegreen.egg-info → codegreen-0.4.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codegreen
-Version: 0.4.7
+Version: 0.4.9
 Summary: Know the true energy cost of your code
 Author-email: Saurabhsingh Rajput <saurabh@dal.ca>
 Maintainer-email: Saurabhsingh Rajput <saurabh@dal.ca>
@@ -413,6 +413,7 @@ Requires-Dist: packaging>=21.0
 Requires-Dist: markdown-it-py<4.0.0,>=3.0.0
 Requires-Dist: tree-sitter<0.26,>=0.21
 Requires-Dist: tree-sitter-language-pack<1.0,>=0.7
+Requires-Dist: tree-sitter-java<0.24,>=0.23
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
@@ -429,6 +430,17 @@ Provides-Extra: viz
 Requires-Dist: matplotlib>=3.5.0; extra == "viz"
 Requires-Dist: pandas>=1.4.0; extra == "viz"
 Requires-Dist: plotly>=5.10.0; extra == "viz"
+Provides-Extra: otlp
+Requires-Dist: opentelemetry-api>=1.20.0; extra == "otlp"
+Requires-Dist: opentelemetry-sdk>=1.20.0; extra == "otlp"
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc>=1.20.0; extra == "otlp"
+Provides-Extra: prometheus
+Requires-Dist: prometheus-client>=0.20.0; extra == "prometheus"
+Provides-Extra: all
+Requires-Dist: opentelemetry-api>=1.20.0; extra == "all"
+Requires-Dist: opentelemetry-sdk>=1.20.0; extra == "all"
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc>=1.20.0; extra == "all"
+Requires-Dist: prometheus-client>=0.20.0; extra == "all"
 Dynamic: license-file
 
 <p align="center">
@@ -436,7 +448,12 @@ Dynamic: license-file
   <img src="docs/website/docs/assets/codegreen_logo_white.svg#gh-dark-mode-only" width="200" alt="CodeGreen Logo">
 </p>
 
-[![DOI](https://zenodo.org/badge/942273936.svg)](https://doi.org/10.5281/zenodo.18371771)
+[![PyPI](https://img.shields.io/pypi/v/codegreen)](https://pypi.org/project/codegreen/)
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/codegreen?period=total&units=NONE&left_color=GREY&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/codegreen)
+[![GitHub stars](https://img.shields.io/github/stars/SMART-Dal/codegreen)](https://github.com/SMART-Dal/codegreen/stargazers)
+[![License](https://img.shields.io/badge/license-MPL%202.0-blue)](LICENSE)
+[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macOS%20%7C%20windows-lightgrey)](https://pypi.org/project/codegreen/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18371771.svg)](https://doi.org/10.5281/zenodo.18371771)
 
 # CodeGreen - Garage for Energy Measurement and Optimization
 
@@ -452,6 +469,8 @@ pip install codegreen
 
 Pre-built wheels available for Linux x86_64 and macOS ARM64 (Apple Silicon). Includes the native NEMB energy measurement backend.
 
+Optional telemetry exporters for `codegreen monitor`: `pip install "codegreen[otlp]"` (OpenTelemetry/OTLP) or `pip install "codegreen[prometheus]"`.
+
 ### From source (recommended for development)
 
 ```bash
@@ -509,6 +528,23 @@ codegreen measure python script.py -g fine --json
 codegreen measure python script.py -g fine --export-plot energy.html
 ```
 
+### Project profiling, monitoring and timelines
+
+```bash
+# Per-function hotspots for a whole project (build once, run, attribute)
+codegreen project python ./src -r "python main.py" -s "**/*.py"
+
+# GPU work attributed to the launching function (torch/CUDA)
+codegreen project python ./src -r "python train.py" --sync-device cuda
+
+# Continuous host or per-PID sampling, optional OTLP / Prometheus export
+codegreen monitor -d 30 -o energy.jsonl
+codegreen monitor --pid 1234 --exporter prometheus --prometheus-port 9464
+
+# Power, stacks, GC and GPU kernels on one axis for ui.perfetto.dev
+codegreen timeline --nemb nemb.json --jfr run.json --out trace.json
+```
+
 ### Manual measurement from Python (Session API)
 
 For span-based measurement of arbitrary code regions, import `codegreen.Session` directly — no CLI, no AST instrumentation:
@@ -546,7 +582,7 @@ codegreen analyze python script.py --save-instrumented
 ### Benchmark validation (against perf RAPL ground truth)
 
 ```bash
-codegreen benchmark -p nbody spectralnorm -l python -r 5 --profilers codegreen perf
+codegreen benchmark -p nbody -p spectralnorm -l python -r 5 --profiler codegreen --profiler perf
 ```
 
 ## Output formats
@@ -557,7 +593,7 @@ JSON (default for `--json`), CSV, Markdown table, and text summary. The JSON out
 
 Adding a new language requires only a JSON config file in `codegreen/instrumentation/configs/` plus the tree-sitter grammar. No Python code changes needed.
 
-Currently supported: Python, C, C++, Java. JavaScript config exists but is not yet exposed via CLI.
+Currently supported: Python, C, C++, Java, JavaScript. Functions that cannot be framed safely (async, generators, coroutines, C++ `constexpr`) are reported as `skipped_functions` rather than instrumented.
 
 ## Benchmarking
 
@@ -574,11 +610,11 @@ bash scripts/generate_comparison_artifacts.sh docs/benchmarks/
 
 ## Energy Flow Graph (EFG)
 
-CodeGreen includes an Energy Flow Graph module (`codegreen/analysis/cfg/`) that builds energy-annotated control flow graphs from source code:
+CodeGreen includes an Energy Flow Graph module (`codegreen/analysis/efg/`) that builds energy-annotated control flow graphs from source code:
 
 ```python
 from codegreen.analysis.cfg.builder import build_per_method_cfgs
-from codegreen.analysis.cfg.energy_flow import build_efg, efg_to_dot, efg_to_text
+from codegreen.analysis.efg import build_efg, efg_to_dot, efg_to_text
 
 cfgs = build_per_method_cfgs(java_source_code)
 efg = build_efg(cfg_nodes, cfg_edges, "ClassName.method", "File.java", codegreen_data)
@@ -587,6 +623,8 @@ print(efg_to_text(efg))  # compact format for LLM prompts
 
 Features: Ball & Larus branch heuristics, SCC-based hot path computation, three-level accuracy annotations (MEASURED/ESTIMATED/INFERRED), configurable via `EFGConfig`.
 
+See `codegreen/analysis/efg/README.md` for the module layout, a runnable example (`python -m codegreen.analysis.efg.example.demo`), and the current list of known issues. `codegreen.analysis.cfg.energy_flow` still resolves as a back-compat shim.
+
 ## Architecture
 
 - **C++ NEMB backend**: platform-aware energy measurement (RAPL on Linux, IOReport on macOS, EMI on Windows), sub-microsecond timestamping, background polling with lock-free ring buffers

{codegreen-0.4.7 → codegreen-0.4.9}/README.md

@@ -3,7 +3,12 @@
   <img src="docs/website/docs/assets/codegreen_logo_white.svg#gh-dark-mode-only" width="200" alt="CodeGreen Logo">
 </p>
 
-[![DOI](https://zenodo.org/badge/942273936.svg)](https://doi.org/10.5281/zenodo.18371771)
+[![PyPI](https://img.shields.io/pypi/v/codegreen)](https://pypi.org/project/codegreen/)
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/codegreen?period=total&units=NONE&left_color=GREY&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/codegreen)
+[![GitHub stars](https://img.shields.io/github/stars/SMART-Dal/codegreen)](https://github.com/SMART-Dal/codegreen/stargazers)
+[![License](https://img.shields.io/badge/license-MPL%202.0-blue)](LICENSE)
+[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macOS%20%7C%20windows-lightgrey)](https://pypi.org/project/codegreen/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18371771.svg)](https://doi.org/10.5281/zenodo.18371771)
 
 # CodeGreen - Garage for Energy Measurement and Optimization
 
@@ -19,6 +24,8 @@ pip install codegreen
 
 Pre-built wheels available for Linux x86_64 and macOS ARM64 (Apple Silicon). Includes the native NEMB energy measurement backend.
 
+Optional telemetry exporters for `codegreen monitor`: `pip install "codegreen[otlp]"` (OpenTelemetry/OTLP) or `pip install "codegreen[prometheus]"`.
+
 ### From source (recommended for development)
 
 ```bash
@@ -76,6 +83,23 @@ codegreen measure python script.py -g fine --json
 codegreen measure python script.py -g fine --export-plot energy.html
 ```
 
+### Project profiling, monitoring and timelines
+
+```bash
+# Per-function hotspots for a whole project (build once, run, attribute)
+codegreen project python ./src -r "python main.py" -s "**/*.py"
+
+# GPU work attributed to the launching function (torch/CUDA)
+codegreen project python ./src -r "python train.py" --sync-device cuda
+
+# Continuous host or per-PID sampling, optional OTLP / Prometheus export
+codegreen monitor -d 30 -o energy.jsonl
+codegreen monitor --pid 1234 --exporter prometheus --prometheus-port 9464
+
+# Power, stacks, GC and GPU kernels on one axis for ui.perfetto.dev
+codegreen timeline --nemb nemb.json --jfr run.json --out trace.json
+```
+
 ### Manual measurement from Python (Session API)
 
 For span-based measurement of arbitrary code regions, import `codegreen.Session` directly — no CLI, no AST instrumentation:
@@ -113,7 +137,7 @@ codegreen analyze python script.py --save-instrumented
 ### Benchmark validation (against perf RAPL ground truth)
 
 ```bash
-codegreen benchmark -p nbody spectralnorm -l python -r 5 --profilers codegreen perf
+codegreen benchmark -p nbody -p spectralnorm -l python -r 5 --profiler codegreen --profiler perf
 ```
 
 ## Output formats
@@ -124,7 +148,7 @@ JSON (default for `--json`), CSV, Markdown table, and text summary. The JSON out
 
 Adding a new language requires only a JSON config file in `codegreen/instrumentation/configs/` plus the tree-sitter grammar. No Python code changes needed.
 
-Currently supported: Python, C, C++, Java. JavaScript config exists but is not yet exposed via CLI.
+Currently supported: Python, C, C++, Java, JavaScript. Functions that cannot be framed safely (async, generators, coroutines, C++ `constexpr`) are reported as `skipped_functions` rather than instrumented.
 
 ## Benchmarking
 
@@ -141,11 +165,11 @@ bash scripts/generate_comparison_artifacts.sh docs/benchmarks/
 
 ## Energy Flow Graph (EFG)
 
-CodeGreen includes an Energy Flow Graph module (`codegreen/analysis/cfg/`) that builds energy-annotated control flow graphs from source code:
+CodeGreen includes an Energy Flow Graph module (`codegreen/analysis/efg/`) that builds energy-annotated control flow graphs from source code:
 
 ```python
 from codegreen.analysis.cfg.builder import build_per_method_cfgs
-from codegreen.analysis.cfg.energy_flow import build_efg, efg_to_dot, efg_to_text
+from codegreen.analysis.efg import build_efg, efg_to_dot, efg_to_text
 
 cfgs = build_per_method_cfgs(java_source_code)
 efg = build_efg(cfg_nodes, cfg_edges, "ClassName.method", "File.java", codegreen_data)
@@ -154,6 +178,8 @@ print(efg_to_text(efg))  # compact format for LLM prompts
 
 Features: Ball & Larus branch heuristics, SCC-based hot path computation, three-level accuracy annotations (MEASURED/ESTIMATED/INFERRED), configurable via `EFGConfig`.
 
+See `codegreen/analysis/efg/README.md` for the module layout, a runnable example (`python -m codegreen.analysis.efg.example.demo`), and the current list of known issues. `codegreen.analysis.cfg.energy_flow` still resolves as a back-compat shim.
+
 ## Architecture
 
 - **C++ NEMB backend**: platform-aware energy measurement (RAPL on Linux, IOReport on macOS, EMI on Windows), sub-microsecond timestamping, background polling with lock-free ring buffers

{codegreen-0.4.7 → codegreen-0.4.9}/codegreen/__init__.py

@@ -12,7 +12,7 @@ try:
     from importlib.metadata import version as _pkg_version
     __version__ = _pkg_version("codegreen")
 except Exception:
-    __version__ = "0.4.7"  # fallback for dev/editable installs
+    __version__ = "0.4.9"  # fallback for dev/editable installs
 __author__ = "Saurabhsingh Rajput"
 __email__ = "saurabh@dal.ca"
 __description__ = "Know the true energy cost of your code"
@@ -29,7 +29,7 @@ if _install_dir not in _sys.path:
 # instrumenter, or analyzer) does NOT pull in the runtime module and register
 # its atexit hook. The runtime is loaded only when a user actually accesses
 # Session / TaskResult / task.
-_LAZY_RUNTIME_ATTRS = {"Session", "TaskResult", "task"}
+_LAZY_RUNTIME_ATTRS = {"Session", "TaskResult", "task", "Monitor", "annotate_request"}
 
 
 def __getattr__(name):
@@ -45,6 +45,8 @@ __all__ = [
     "__email__",
     "__description__",
     "Session",
+    "Monitor",
+    "annotate_request",
     "TaskResult",
     "task",
 ]