eco-ci-energy-estimation
eco-ci-energy-estimation copied to clipboard
green-coding-solutions
Docs: Clarify script usage, add setup files, improve README
Hi,
When trying to set up this repo locally, I found pip install . doesn't work (missing setup.py/pyproject.toml), indicating the main usage is running the shell scripts directly, especially in CI. I also noticed local script execution needs specific arguments/environment variables which wasn't detailed.
To help clarify setup, I've made these improvements:
- Updated
README.md: Clarified the script-based/CI usage model, fixed install steps (focusing on cloning +requirements.txt), added a Dependencies section, and improved local execution guidance (mentioning args/env vars needed). - Added
requirements.txt: Makes it easy to install the Python libraries used by the scripts (pip install -r requirements.txt). - Improved
.gitignore: Replaced the minimal version with a standard Python one.
My aim was to make it easier for users to understand how to set up and run this useful toolset! Amazing repo by the way.
Hey @KaranSinghDev ,
thanks for using our tool!
I gotta say I do not quite understand the PR. This GitHub action does not use Python. Was it intended for a different repository?
Hi @ArneTR Thanks for the feedback! You're right, the Action itself runs shell scripts. I am sorry if the focus on Python setup seemed misplaced. My thinking was: The shell scripts do call Python and rely on packages like psutil, codecarbon, etc. Adding requirements.txt and a standard .gitignore helps manage these Python dependencies and improves repo hygiene for local testing/understanding. Updating the README clarifies this script-based nature and makes setup clearer (install Python deps -> run scripts with args/env vars). Essentially, my aim was to improve clarity and setup for anyone interacting with the repository's components, acknowledging the primary usage is script-based within CI.
Can you please point me to the line where you saw that the shell scripts call Python?