Skip to content

Commit 3e13f9d

Browse files
committed
Minor
1 parent 24d91e9 commit 3e13f9d

File tree

15 files changed

+21
-21
lines changed

15 files changed

+21
-21
lines changed

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ pip install -r requirements.txt
1515

1616
# Run specific detectors for testing
1717
python3 -m energy_dependency_inspector docker <container_name>
18-
python3 -m energy_dependency_inspector host --skip-os-packages --skip-hash-generation
18+
python3 -m energy_dependency_inspector host --skip-os-packages --skip-hash-collection
1919

2020
# Execute linting and formatting
2121
pre-commit run --files $(git diff --name-only --diff-filter=ACMR HEAD)

SPECIFICATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The [Green Metrics Tool](https://github.com/green-coding-solutions/green-metrics
88

99
### Functional Requirements
1010

11-
1. Dependency Detection: Build a standalone energy dependency inspector that can export JSON with all project dependencies
11+
1. Dependency Detection: Build a standalone dependency inspector that can export JSON with all dependencies and other relevant information
1212
2. Version/Hash Output: Each dependency should include a preferably semantic versioning and, if available, a hash value
1313
3. Multi-Package Manager Support: Support various package managers and OS package systems
1414
4. Modular Architecture: Implement as modular add-ons for different systems and package managers

docs/technical/adding-new-detectors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Adding New Package Manager Detectors
22

3-
This guide provides a comprehensive plan for adding new package manager detectors to the energy dependency inspector system.
3+
This guide provides a comprehensive plan for adding new package manager detectors to the energy-dependency-inspector system.
44

55
## Overview
66

7-
The energy dependency inspector uses a modular detector architecture where each package manager has its own detector class that implements the `PackageManagerDetector` interface. This design allows for easy extensibility while maintaining consistent behavior across all detectors.
7+
The energy-dependency-inspector uses a modular detector architecture where each package manager has its own detector class that implements the `PackageManagerDetector` interface. This design allows for easy extensibility while maintaining consistent behavior across all detectors.
88

99
## Prerequisites
1010

docs/technical/architecture/adr/0001-runtime-snapshot-approach.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Accepted
66

77
## Context
88

9-
The energy dependency inspector needs to analyze project dependencies. Two approaches were considered:
9+
The energy-dependency-inspector needs to analyze project dependencies. Two approaches were considered:
1010

1111
1. **Source File Parsing**: Analyze package manager files (requirements.txt, package.json, etc.)
1212
2. **Runtime Snapshot**: Analyze running environments to capture actually installed packages

docs/technical/architecture/adr/0002-modular-detector-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Accepted
66

77
## Context
88

9-
The energy dependency inspector needs to support multiple package managers across different environments. Architecture options considered:
9+
The energy-dependency-inspector needs to support multiple package managers across different environments. Architecture options considered:
1010

1111
1. Monolithic approach with hardcoded package manager logic
1212
2. Plugin-based system with dynamic loading

docs/technical/architecture/adr/0003-read-only-operations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Accepted
66

77
## Context
88

9-
The energy dependency inspector needs to operate in various environments including CI/CD pipelines and containerized applications. Implementation approaches considered:
9+
The energy-dependency-inspector needs to operate in various environments including CI/CD pipelines and containerized applications. Implementation approaches considered:
1010

1111
1. Allow modifications and installations to gather complete dependency information
1212
2. Implement read-only operations with limitations on available information
@@ -18,7 +18,7 @@ We will implement a strict read-only operations constraint across all dependency
1818

1919
## Rationale
2020

21-
Read-only operations ensure the energy dependency inspector can be safely used in any environment without risk of system modification or side effects.
21+
Read-only operations ensure the energy-dependency-inspector can be safely used in any environment without risk of system modification or side effects.
2222

2323
**Constraint Details**:
2424

docs/technical/architecture/adr/0004-unix-only-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Proposed
66

77
## Context
88

9-
The energy dependency inspector needs to define its target platform scope. Platform support options considered:
9+
The energy-dependency-inspector needs to define its target platform scope. Platform support options considered:
1010

1111
1. Cross-platform support including Windows, macOS, and Linux
1212
2. Unix-based systems only (Linux, macOS, BSD variants)

docs/technical/architecture/adr/0005-dependency-hash-strategy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Accepted
66

77
## Context
88

9-
The energy dependency inspector needs to track changes in software dependencies across different environments and time periods. Several approaches exist for detecting when dependencies have changed:
9+
The energy-dependency-inspector needs to track changes in software dependencies across different environments and time periods. Several approaches exist for detecting when dependencies have changed:
1010

1111
1. **No change detection**: Only track package names and versions
1212
2. **Timestamp-based detection**: Use modification times to detect changes

energy_dependency_inspector/core/venv_checker.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ def check_venv() -> None:
1313
if (sys.version_info.major, sys.version_info.minor) < (3, 10):
1414
print(
1515
"Python version is NOT greater than or equal to 3.10. "
16-
"Energy Dependency Inspector requires Python 3.10 at least. "
16+
"energy-dependency-inspector requires Python 3.10 at least. "
1717
"Please upgrade your Python version."
1818
)
1919
sys.exit(1)
@@ -29,7 +29,7 @@ def check_venv() -> None:
2929
f"Error:\n\n"
3030
f"You are not using a venv, or venv is not in expected directory {expected_venv}\n"
3131
f"Current venv is in {sys.prefix}\n\n"
32-
f"The Energy Dependency Inspector needs a venv to correctly find installed packages "
32+
f"The energy-dependency-inspector needs a venv to correctly find installed packages "
3333
f"and also necessary include paths.\n"
3434
f"Please check the installation instructions.\n\n"
3535
f"Maybe you just forgot to activate your venv? Try:\n"

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ build-backend = "setuptools.build_meta"
55
[project]
66
name = "energy-dependency-inspector"
77
version = "0.2.0"
8-
description = "A standalone energy dependency inspector that exports JSON with all project dependencies"
8+
description = "An inspector of dependencies in the context of energy measurements that exports JSON with relevant information"
99
readme = "README.md"
1010
requires-python = ">=3.10"
1111
license = {text = "MIT"}
1212
authors = [
1313
{name = "Green Coding Solutions"}
1414
]
15-
keywords = ["dependencies", "docker", "containers", "package-manager", "security"]
15+
keywords = ["dependencies", "docker", "containers", "package-manager", "energy", "inspection"]
1616
classifiers = [
1717
"Development Status :: 3 - Alpha",
1818
"Intended Audience :: Developers",

0 commit comments

Comments
 (0)