Archey 4

Archey is a simple system information tool written in Python

Why (again) a f*cking new Archey fork ?

The answer is here.

Note : Since the 21st September of 2017, you may notice that this repository no longer has the official status of fork.
Actually, the maintainer decided to separate it from the original one's "network" with the help of GitHub's staff.
Nevertheless, this piece of software is still a fork of djmelik's Archey project.

Which packages do I need to run this script ?

Required packages

python3
python3-distro (python-distro on Arch Linux)
python3-netifaces (python-netifaces on Arch Linux)
procps (potentially procps-ng)

Highly recommended packages

Environments	Packages	Reasons	Notes
All	`dnsutils` or `bind-tools`	WAN_IP would be detected faster	Would provide `dig`
All	`lm-sensors` or `lm_sensors`	Temperature would be more accurate	φ
Graphical	`pciutils` or `pciutils-ng`	GPU wouldn't be detected without it	Would provide `lspci`
Graphical	`wmctrl`	WindowManager would be more accurate	φ
Virtual	`virt-what` and `dmidecode`	Model would contain details about the hypervisor	`archey` would have to be run as root

⚠️ Various notes to read before going down ⚠️

Note to Debian Jessie users : As python3-distro module is not available in your repositories, you should opt for an installation from PIP.

Installation

Install from package

First, grab a package for your distribution from the latest release here.
Now, it's time to use your favorite package manager. Some examples :

Arch-based distributions (source)

 $ sudo pacman -U ./archey4-v4.Y.Z-R-any.pkg.tar.xz

Debian-based distributions (source)

 $ sudo apt install ./archey4-v4.Y.Z-R-all.deb

RPM-based distributions (source will be available soon !)
```
 $ sudo dnf install ./archey4-4.Y.Z-R.fc28.noarch.rpm
```

Install with PIP

$ sudo pip3 install archey4

Install from source

### Step 1 : Fetch the source ###

# If you want the latest release :
$ wget https://github.com/HorlogeSkynet/archey4/archive/v4.6.0.tar.gz
$ tar xvzf v4.6.0.tar.gz
$ cd archey4-4.6.0/
# _______________________________

# If you want the latest changes :
$ git clone https://github.com/HorlogeSkynet/archey4.git
$ cd archey4/
# _______________________________


### Step 2 : Installation ###

# If you have PIP installed on your system :
$ sudo pip3 install .
# So if one day you wanna uninstall Archey
$ sudo pip3 uninstall archey4
# _________________________________________

# But if you don't have PIP, no worries :
$ sudo python3 setup.py install
# _______________________________________

### Step 3 (Optional) : Configuration files

# System-wide configuration :
$ sudo mkdir /etc/archey4
$ sudo cp archey/config.json /etc/archey4/config.json
# ___________________________
# User-specific configuration :
$ mkdir ~/.config/archey4
$ cp archey/config.json ~/.config/archey4/config.json
# _____________________________

### Step 4 (Optional) : I want a standalone script, as before !

# You can go through StickyTape for this :
$ sudo pip3 install stickytape
$ stickytape --add-python-path . --output-file dist/archey archey/__main__.py
$ python3 dist/archey
# ________________________________________

# You can either use PyInstaller :
$ sudo pip3 install pyinstaller
$ pyinstaller --distpath dist --specpath dist --name archey --onefile archey/__main__.py
$ ./dist/archey
# ________________________________

# You can now move this script anywhere, as before :
$ chmod +x dist/archey
$ sudo mv dist/archey /usr/local/bin/
# __________________________________________________

Usage

$ archey

or if you only want to try this out (for instance, from source) :

$ python3 -m archey

Configuration (optional)

Since the version 4.3.0, Archey 4 may be "tweaked" a bit with external configuration.
You can place a config.json file in these locations :

/etc/archey4/config.json (system preferences)
~/.config/archey4/config.json (user preferences)
./config.json (local preferences)

If an option is defined in multiple places, it will be overridden according to the order above (local preferences > user preferences > system preferences).

The example file provided in this repository lists exhaustively the parameters you can set.
Below, some further explanations of each option available :

{
	// If set to `false`, configurations defined afterwards won't be loaded.
	// Developers running Archey from the original project may keep in there the original `config.json` while having their own external configuration set elsewhere.
	"allow_overriding": true,
	// If set to `true`, any execution warning or error would be hidden.
	// It may not apply to configuration parsing warnings.
	"suppress_warnings": false,
	"entries": {
		// Set to `false` each entry you want to mask.
	},
	"colors_palette": {
		// Set this option to `true` to display a beautiful colors palette.
		// `false` by default for backward compatibility with non-Unicode locales.
		"use_unicode": false
	},
	"default_strings": {
		// Use this section to override default strings.
	},
	"ip_settings": {
		// The maximum number of local addresses you want to display.
		// `false` --> Unlimited.
		"lan_ip_max_count": 2,
		// `false` would make Archey displays only IPv4 WAN addresses.
		"wan_ip_v6_support": true
	},
	"temperature": {
		// The character to display between the temperature value and the unit (as '°' in 53.2°C).
		// Set to ' ' (space) by default for backward compatibility with non-Unicode locales.
		"char_before_unit": " ",
		// Display temperature values in Fahrenheit instead of Celsius.
		"use_fahrenheit": false
	},
	"timeout": {
		// Some values you can adjust if the default ones look undersized for your system (seconds).
	}
	"limits": {
		// Some threshold values you can adjust affecting disk/ram warning/danger color (percent).
		'ram': {
			"warning": 33.3,
			"danger": 66.7
		},
		'disk': {
			"warning": 50,
			"danger": 75
		}
	}
}

Test cases

Tests are now available. Here is a short procedure to run them (you'll only need python3) :

$ git clone https://github.com/HorlogeSkynet/archey4.git
$ cd archey4/
# If you got `setuptools` installed
$ python3 setup.py test
# But if you still don't, no worries !
$ python3 -m unittest

Any improvement would be appreciated.

Notes to users

If you run archey as root, the script will list the processes running by other users on your system in order to display the Window Manager & Desktop Environment outputs correctly.
During the setup procedure, I advised you to copy this script into the /usr/local/bin/ folder, you may want to check what it does beforehand.
If you experience any trouble during the installation or usage, please do open an issue.
If you had to adapt the script to make it work on your system, please open a pull request so as to share your modifications with the rest of the world and participate in this project !
When looking up your public IP address (WAN_IP), Archey will try at first to run a DNS query for myip.opendns.com, against OpenDNS's resolver(s). On error, it would fall back on regular HTTPS request(s) to https://ident.me (server sources).

czr137 / archey4