Skip to content

Commit 42d0551

Browse files
committed
Improve project description
1 parent 3e13f9d commit 42d0551

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# energy-dependency-inspector
1+
# Energy Dependency Inspector
22

3-
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.
3+
A tool for capturing dependency snapshots of running systems by querying their package managers directly. Unlike filesystem-scanning approaches, it inspects the actual installed state of packages as reported by the system's package management tools. Originally designed to reveal relevant changes when conducting energy measurements, it can also be used as a general-purpose dependency resolver. By tracking installed packages and their versions, you can identify whether changes in performance, energy consumption, or behavior are due to code modifications or dependency updates.
44

5-
Its main focus is dependency resolving of Docker containers, but it also supports dependency resolving on the host system. The output is a structured JSON that includes information about all the installed packages from supported sources with their version and unique hash values.
5+
The tool provides both a command-line interface and a Python library for programmatic use. It supports dependency inspection of Docker containers and host systems, outputting structured JSON with package information, versions, and unique hash values.
66

77
## Installation
88

pyproject.toml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,27 @@ build-backend = "setuptools.build_meta"
55
[project]
66
name = "energy-dependency-inspector"
77
version = "0.2.0"
8-
description = "An inspector of dependencies in the context of energy measurements that exports JSON with relevant information"
8+
description = "Captures dependency snapshots of software systems for tracking changes across measurements. Originally designed for energy measurement contexts, also usable as a general-purpose dependency resolver."
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", "energy", "inspection"]
15+
keywords = ["dependencies", "docker", "containers", "package-manager", "energy", "inspection", "snapshot", "resolver"]
1616
classifiers = [
1717
"Development Status :: 3 - Alpha",
1818
"Intended Audience :: Developers",
19+
"Intended Audience :: System Administrators",
1920
"Topic :: Software Development :: Libraries :: Python Modules",
2021
"Topic :: System :: Systems Administration",
22+
"Topic :: System :: Monitoring",
23+
"Topic :: Utilities",
2124
"Programming Language :: Python :: 3",
2225
"Programming Language :: Python :: 3.10",
2326
"Programming Language :: Python :: 3.11",
2427
"Programming Language :: Python :: 3.12",
28+
"License :: OSI Approved :: MIT License",
2529
]
2630
dynamic = ["dependencies", "optional-dependencies"]
2731

0 commit comments

Comments
 (0)