Skip to content

Commit da5f031

Browse files
committed
Upload package to PyPI
1 parent cd6bcbe commit da5f031

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ __pycache__/
77
.mypy_cache
88
*.egg-info/
99
build
10+
dist
1011

1112
# Environments
1213
.env

MAINTAINERS.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Maintainer Guide
2+
3+
This document contains information for official maintainers of the Energy Dependency Inspector project.
4+
5+
## Publishing to PyPI
6+
7+
Official documentation: <https://packaging.python.org/en/latest/tutorials/packaging-projects/>
8+
9+
To publish a new version to PyPI, follow these steps:
10+
11+
1. **Bump the version** in `pyproject.toml`
12+
13+
2. **Build the package:**
14+
15+
```sh
16+
# Install/upgrade build tools
17+
python3 -m pip install --upgrade build
18+
19+
# Build the distribution packages
20+
python3 -m build
21+
```
22+
23+
3. **Upload to PyPI:**
24+
25+
```sh
26+
# Install/upgrade twine for uploading
27+
python3 -m pip install --upgrade twine
28+
29+
# Upload to PyPI
30+
python3 -m twine upload dist/*
31+
```
32+
33+
You will need a PyPI API token with maintainer access. Get one here: <https://pypi.org/manage/account/token/>

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
# Energy Dependency Inspector
22

3+
[![PyPI](https://img.shields.io/pypi/v/energy-dependency-inspector)](https://pypi.org/project/energy-dependency-inspector/)
4+
35
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.
46

57
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.
68

79
## Installation
810

11+
**From PyPI:**
12+
13+
```bash
14+
pip install energy-dependency-inspector
15+
```
16+
17+
**From source:**
18+
919
```bash
1020
git clone https://github.com/green-coding-solutions/energy-dependency-inspector
1121
cd energy-dependency-inspector

0 commit comments

Comments
 (0)