Metadata-Version: 2.1
Name: coffeefetch
Version: 1.2.2
Summary: A lightweight system information grabber written in Python
Project-URL: Homepage, https://github.com/TeaPixl/CoffeeFetch
Project-URL: Bug Tracker, https://github.com/TeaPixl/CoffeeFetch/issues
Author-email: Logan Allen <ltallen392@gmail.com>
License-File: LICENCE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# CoffeeFetch
![image](https://github.com/TeaPixl/CoffeeFetch/assets/106362493/71e27b7e-3d09-4b5b-8b6e-384b3f781b1b)
## A lightweight system info grabber written in Python

## Introduction
CoffeeFetch is a system information grabber for Unix systems that fetches your system information and displays it to the screen. This is a lightweight package and is built to be run on systems without the use of a Window Manager or Desktop Enviornment and is displayed directly in in TTY. It will attempt to grab you CPU model, CPU frequency, current RAM consumption, current disk usage, Operating System, CPU architecture, IP Address, hostname, and OS version.

## Installation
It is required to use Python 3.7 or greater for this package. 
> psutil >= 5.9.5 is required for this package.

Firstly, clone this repository:
```
git clone https://github.com/TeaPixl/CoffeeFetch/
cd CoffeeFetch
```
Then, install the required Python modules
```
pip install -r requirements.txt
```
Build and install the .whl file
> Change the X.X.X to the version you have
```
python3 -m build
cd dist/
pip install coffeefetch-X.X.X-py3-none-any.whl
```
OR

```
pip install coffeefetch
```

## Usage
To use CoffeeFetch, type into your terminal:
```
python3 -m coffeefetch
```

## NOTE
This project is currently in the works and I have not finished it yet.
This is a NEW repository so feel free to post any issues you may find.

Currently working on:
+ adding -help and other discrete commands
+ testing
