Power consumption with python by lordksix

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Power consumption with python by lordksix]

Power consumption with python by lordksix is a console application. This application runs on python and only works on LINUX. The user writes the code that wants to analyze in the function application(), in app.py. The application will run the code and print on the console the total energy consume by the code and the power consumption.

(back to top)

🛠 Built With

Tech Stack

Programming Language

• Python

Key Features

• Separation of responsibilities
• Docstrings and docpage implement - Google standard and MkDocs
• Information saved in a CSV file
• Runs 100 interaction for a more reliable result

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• To clone or fork this repo
• Python installed in your machine
• It is recommended to use a virtual environment

For more information on how to install ruby on your machine:

• How to install Python

Setup

Clone this repository to your desired folder:

For example, using Ubuntu:

  cd my-desired-folder
  git clone https://github.com/lordksix/power-consumption-app.git

For more information on how to clone or fork a repository:

• How to clone a repo
• How to fork a repo

Install

To install dependencies, the following command must be run in the terminal:

  cd power-consumption-app
  python -m pip install power-consumption

Usage

In the project directory, write the code you want to analyze in the app.py file, function application.py. Afterwards, run the following command:

  python3 app.py

For further information read the docs or open power-consumption-docs.pdf

Run tests

Tests to be implemented

(back to top)

👥 Authors

👤 lordksix

• GitHub: @lordksix
• LinkedIn: @wladpasquel
• Medium: @wladimir.pasquel

(back to top)

🔭 Future Features

Future changes:

• Implementation of tests

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.

(back to top)

🙏 Acknowledgments

I want to thank PowerAPI for the heavy lifting with their library.

(back to top)

❓ FAQ

• Do I need a IDE or a special text editor to make changes?

  • No, you don't. You can use NotePad to make changes.

(back to top)

📝 License

This project is GNU v3 licensed.

(back to top)