Skip to content

Commit 24d91e9

Browse files
committed
Rename project to Energy Dependency Inspector
1 parent 16a70a2 commit 24d91e9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+224
-221
lines changed

CLAUDE.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Dependency Resolver Development Guide
1+
# Energy Dependency Inspector Development Guide
22

33
## Quick Start
44

55
```bash
66
source venv/bin/activate
7-
python3 -m dependency_resolver --debug
7+
python3 -m energy_dependency_inspector --debug
88
```
99

1010
## Development Commands
@@ -14,8 +14,8 @@ python3 -m dependency_resolver --debug
1414
pip install -r requirements.txt
1515

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

2020
# Execute linting and formatting
2121
pre-commit run --files $(git diff --name-only --diff-filter=ACMR HEAD)
@@ -49,10 +49,10 @@ Python with venv, pip, and pytest (Unix-only)
4949

5050
```bash
5151
# Debug specific detector issues
52-
python3 -m dependency_resolver --debug
52+
python3 -m energy_dependency_inspector --debug
5353

5454
# Test individual detectors (modify main temporarily)
55-
python3 -c "from dependency_resolver.detectors.dpkg_detector import DpkgDetector; print(DpkgDetector().get_name())"
55+
python3 -c "from energy_dependency_inspector.detectors.dpkg_detector import DpkgDetector; print(DpkgDetector().get_name())"
5656
```
5757

5858
## Style & Workflow
@@ -66,9 +66,9 @@ python3 -c "from dependency_resolver.detectors.dpkg_detector import DpkgDetector
6666

6767
## Key Directories
6868

69-
- `dependency_resolver/detectors/` - Package manager detection implementations
70-
- `dependency_resolver/executors/` - Environment execution adapters
71-
- `dependency_resolver/core/` - Base interfaces and orchestrator
69+
- `energy_dependency_inspector/detectors/` - Package manager detection implementations
70+
- `energy_dependency_inspector/executors/` - Environment execution adapters
71+
- `energy_dependency_inspector/core/` - Base interfaces and orchestrator
7272
- `tests/` - Test suites organized by component (detectors, executors, integration, specialized)
7373
- `docs/guides/` - User guides (quick start, troubleshooting)
7474
- `docs/usage/` - Detailed usage documentation (CLI, API, output format)

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Contributing to dependency-resolver
1+
# Contributing to energy-dependency-inspector
22

3-
Thank you for your interest in contributing to the dependency-resolver project! This guide will help you get started with development and understand our contribution process.
3+
Thank you for your interest in contributing to the energy-dependency-inspector project! This guide will help you get started with development and understand our contribution process.
44

55
## Development Setup
66

77
```bash
88
# Clone the repository
9-
git clone https://github.com/green-coding-solutions/dependency-resolver
10-
cd dependency-resolver
9+
git clone https://github.com/green-coding-solutions/energy-dependency-inspector
10+
cd energy-dependency-inspector
1111

1212
# Create and activate virtual environment
1313
python3 -m venv venv
@@ -62,7 +62,7 @@ source venv/bin/activate
6262
pytest
6363

6464
# Run with coverage
65-
pytest --cov=dependency_resolver
65+
pytest --cov=energy_dependency_inspector
6666

6767
# Run specific test file
6868
pytest tests/detectors/pip/test_pip_docker_detection.py
@@ -77,22 +77,22 @@ While pre-commit hooks will run automatically, you can also run these tools manu
7777
source venv/bin/activate
7878

7979
# Run pylint (as specified in project guidelines)
80-
pylint dependency_resolver/
80+
pylint energy_dependency_inspector/
8181

8282
# Run type checking
83-
mypy dependency_resolver/
83+
mypy energy_dependency_inspector/
8484

8585
# Format code
86-
black dependency_resolver/
86+
black energy_dependency_inspector/
8787
```
8888

8989
### Project Structure
9090

9191
```plain
92-
dependency-resolver/
92+
energy-dependency-inspector/
9393
├── pyproject.toml
9494
├── requirements*.txt
95-
├── dependency_resolver/ # Main package
95+
├── energy_dependency_inspector/ # Main package
9696
│ ├── __main__.py # CLI entry point
9797
│ ├── core/ # Orchestration and interfaces
9898
│ ├── detectors/ # Package manager detectors
@@ -150,4 +150,4 @@ If you have questions or need help:
150150

151151
## Thank You
152152

153-
Your contributions help make dependency-resolver better for everyone. We appreciate your time and effort!
153+
Your contributions help make energy-dependency-inspector better for everyone. We appreciate your time and effort!

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# dependency-resolver
1+
# energy-dependency-inspector
22

33
A tool for creating snapshots of installed packages on specified target environments. The project provides both a command-line interface and a Python library for programmatic use.
44

@@ -7,25 +7,25 @@ Its main focus is dependency resolving of Docker containers, but it also support
77
## Installation
88

99
```bash
10-
git clone https://github.com/green-coding-solutions/dependency-resolver
11-
cd dependency-resolver
10+
git clone https://github.com/green-coding-solutions/energy-dependency-inspector
11+
cd energy-dependency-inspector
1212
pip install .
1313
```
1414

1515
## Quick Start
1616

1717
```bash
1818
# Analyze host system
19-
python3 -m dependency_resolver
19+
python3 -m energy_dependency_inspector
2020

2121
# Analyze Docker container
22-
python3 -m dependency_resolver docker nginx
22+
python3 -m energy_dependency_inspector docker nginx
2323

2424
# Pretty print output
25-
python3 -m dependency_resolver --pretty-print
25+
python3 -m energy_dependency_inspector --pretty-print
2626

2727
# Get help with all options
28-
python3 -m dependency_resolver -h
28+
python3 -m energy_dependency_inspector -h
2929
```
3030

3131
## Supported Package Managers
@@ -49,13 +49,13 @@ For terminal usage with full control over options and environments.
4949
Use as a Python library in other projects:
5050

5151
```python
52-
import dependency_resolver
52+
import energy_dependency_inspector
5353

5454
# Analyze host system
55-
deps = dependency_resolver.resolve_host_dependencies()
55+
deps = energy_dependency_inspector.resolve_host_dependencies()
5656

5757
# Analyze Docker container
58-
docker_deps = dependency_resolver.resolve_docker_dependencies("nginx")
58+
docker_deps = energy_dependency_inspector.resolve_docker_dependencies("nginx")
5959
```
6060

6161
## Documentation

SPECIFICATION.md

Lines changed: 4 additions & 4 deletions
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 dependency resolver that can export JSON with all project dependencies
11+
1. Dependency Detection: Build a standalone energy dependency inspector that can export JSON with all project dependencies
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
@@ -40,13 +40,13 @@ The [Green Metrics Tool](https://github.com/green-coding-solutions/green-metrics
4040
### Command Interface
4141

4242
```sh
43-
python3 -m dependency_resolver <environment_type> <environment_identifier> <options>
43+
python3 -m energy_dependency_inspector <environment_type> <environment_identifier> <options>
4444
```
4545

4646
Basic usage:
4747

48-
- **Host system**: `python3 -m dependency_resolver`
49-
- **Docker container**: `python3 -m dependency_resolver docker nginx`
48+
- **Host system**: `python3 -m energy_dependency_inspector`
49+
- **Docker container**: `python3 -m energy_dependency_inspector docker nginx`
5050

5151
Supported environments: `host`, `docker` (future: `podman`)
5252

docs/guides/quick-start.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Quick Start Guide
22

3-
Get up and running with dependency-resolver in minutes.
3+
Get up and running with energy-dependency-inspector in minutes.
44

55
## Installation
66

77
```bash
8-
git clone https://github.com/green-coding-solutions/dependency-resolver
9-
cd dependency-resolver
8+
git clone https://github.com/green-coding-solutions/energy-dependency-inspector
9+
cd energy-dependency-inspector
1010
pip install .
1111
```
1212

@@ -15,23 +15,23 @@ pip install .
1515
### Analyze Host System
1616

1717
```bash
18-
python3 -m dependency_resolver
18+
python3 -m energy_dependency_inspector
1919
```
2020

2121
This analyzes your current system and outputs a JSON report of all detected package managers and their dependencies.
2222

2323
### Analyze Docker Container
2424

2525
```bash
26-
python3 -m dependency_resolver docker nginx
26+
python3 -m energy_dependency_inspector docker nginx
2727
```
2828

2929
Replace `nginx` with any Docker container name or ID.
3030

3131
### Pretty Print Output
3232

3333
```bash
34-
python3 -m dependency_resolver --pretty-print
34+
python3 -m energy_dependency_inspector --pretty-print
3535
```
3636

3737
## Understanding the Output
@@ -60,20 +60,20 @@ Each section represents a package manager (dpkg, pip, npm, etc.) with its detect
6060

6161
```bash
6262
cd /path/to/your/python/project
63-
python3 -m dependency_resolver --working-dir .
63+
python3 -m energy_dependency_inspector --working-dir .
6464
```
6565

6666
### Node.js Project Analysis
6767

6868
```bash
6969
cd /path/to/your/nodejs/project
70-
python3 -m dependency_resolver --working-dir .
70+
python3 -m energy_dependency_inspector --working-dir .
7171
```
7272

7373
### Debug Mode
7474

7575
```bash
76-
python3 -m dependency_resolver --debug
76+
python3 -m energy_dependency_inspector --debug
7777
```
7878

7979
Enables verbose output to troubleshoot detection issues.

docs/guides/troubleshooting.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Troubleshooting Guide
22

3-
Common issues and solutions when using dependency-resolver.
3+
Common issues and solutions when using energy-dependency-inspector.
44

55
## General Issues
66

@@ -10,7 +10,7 @@ Common issues and solutions when using dependency-resolver.
1010

1111
**Solutions**:
1212

13-
1. Enable debug mode: `python3 -m dependency_resolver --debug`
13+
1. Enable debug mode: `python3 -m energy_dependency_inspector --debug`
1414
2. Check if package managers are installed in the target environment
1515
3. Verify permissions to read package manager files
1616

@@ -30,7 +30,7 @@ Common issues and solutions when using dependency-resolver.
3030
docker ps
3131

3232
# Use container ID
33-
python3 -m dependency_resolver docker a1b2c3d4e5f6
33+
python3 -m energy_dependency_inspector docker a1b2c3d4e5f6
3434
```
3535

3636
### Permission Errors
@@ -57,7 +57,7 @@ python3 -m dependency_resolver docker a1b2c3d4e5f6
5757

5858
```bash
5959
# For virtual environment analysis
60-
python3 -m dependency_resolver --working-dir /path/to/venv
60+
python3 -m energy_dependency_inspector --working-dir /path/to/venv
6161
```
6262

6363
### Node.js/NPM Detection
@@ -85,7 +85,7 @@ python3 -m dependency_resolver --working-dir /path/to/venv
8585
Enable debug mode for detailed information:
8686

8787
```bash
88-
python3 -m dependency_resolver --debug
88+
python3 -m energy_dependency_inspector --debug
8989
```
9090

9191
Debug output shows:
@@ -148,7 +148,7 @@ npm --version
148148

149149
1. Use `--pretty-print` for readable format
150150
2. Check for error messages mixed with output
151-
3. Redirect stderr: `python3 -m dependency_resolver 2>/dev/null`
151+
3. Redirect stderr: `python3 -m energy_dependency_inspector 2>/dev/null`
152152

153153
### Missing Expected Packages
154154

@@ -200,17 +200,17 @@ If issues persist:
200200

201201
```bash
202202
# Basic debug
203-
python3 -m dependency_resolver --debug
203+
python3 -m energy_dependency_inspector --debug
204204

205205
# Host analysis with debug
206-
python3 -m dependency_resolver host --debug
206+
python3 -m energy_dependency_inspector host --debug
207207

208208
# Docker analysis with debug
209-
python3 -m dependency_resolver docker container_name --debug
209+
python3 -m energy_dependency_inspector docker container_name --debug
210210

211211
# Skip system scope for faster testing
212-
python3 -m dependency_resolver --skip-os-packages --debug
212+
python3 -m energy_dependency_inspector --skip-os-packages --debug
213213

214214
# Test specific working directory
215-
python3 -m dependency_resolver --working-dir /path --debug
215+
python3 -m energy_dependency_inspector --working-dir /path --debug
216216
```

0 commit comments

Comments
 (0)