Edit badges, update installation instructions, swap github.com entries to git.sysmd.uk
All checks were successful
Lint & Security / precommit-and-security (pull_request) Successful in 48s
All checks were successful
Lint & Security / precommit-and-security (pull_request) Successful in 48s
This commit is contained in:
79
README.md
79
README.md
@@ -1,8 +1,6 @@
|
||||
[](LICENCE)
|
||||
[](https://github.com/guardutils/filedust/)
|
||||
[](https://github.com/guardutils/filedust/releases)
|
||||
[](https://pypi.org/project/filedust/#history)
|
||||
[](https://pypi.org/project/filedust/)
|
||||
[](https://git.sysmd.uk/guardutils/filedust/src/branch/main/LICENCE)
|
||||
[](https://git.sysmd.uk/guardutils/filedust/releases)
|
||||
[](https://git.sysmd.uk/guardutils/filedust/src/branch/main/.pre-commit-config.yaml)
|
||||
|
||||
# filedust
|
||||
|
||||
@@ -42,6 +40,65 @@ Shows how much disk space can be freed.
|
||||
|
||||
## Installation
|
||||
|
||||
### From GuardUtils package repo
|
||||
|
||||
This is the preferred method of installation.
|
||||
|
||||
### Debian/Ubuntu
|
||||
|
||||
#### 1) Import the GPG key
|
||||
|
||||
```bash
|
||||
sudo mkdir -p /usr/share/keyrings
|
||||
curl -fsSL https://repo.sysmd.uk/guardutils/guardutils.gpg | sudo gpg --dearmor -o /usr/share/keyrings/guardutils.gpg
|
||||
```
|
||||
|
||||
The GPG fingerprint is `0032C71FA6A11EF9567D4434C5C06BD4603C28B1`.
|
||||
|
||||
#### 2) Add the APT source
|
||||
|
||||
```bash
|
||||
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/guardutils.gpg] https://repo.sysmd.uk debian main" | sudo tee /etc/apt/sources.list.d/guardutils.list
|
||||
```
|
||||
|
||||
#### 3) Update and install
|
||||
|
||||
```
|
||||
sudo apt update
|
||||
sudo apt install filedust
|
||||
```
|
||||
|
||||
### Fedora/RHEL
|
||||
|
||||
#### 1) Import the GPG key
|
||||
|
||||
```
|
||||
sudo rpm --import https://repo.sysmd.uk/guardutils/guardutils.gpg
|
||||
```
|
||||
|
||||
#### 2) Add the repository configuration
|
||||
|
||||
```
|
||||
sudo tee /etc/yum.repos.d/guardutils.repo > /dev/null << 'EOF'
|
||||
[guardutils]
|
||||
name = GuardUtils Repository
|
||||
baseurl = https://repo.sysmd.uk/rpm/$basearch
|
||||
|
||||
enabled = 1
|
||||
gpgcheck = 1
|
||||
gpgkey = https://repo.sysmd.uk/guardutils/guardutils.gpg
|
||||
|
||||
repo_gpgcheck = 1
|
||||
EOF
|
||||
```
|
||||
|
||||
#### 4) Update and install
|
||||
|
||||
```
|
||||
sudo dnf upgrade --refresh
|
||||
sudo dnf install filedust
|
||||
```
|
||||
|
||||
### From PyPI
|
||||
```
|
||||
pip install filedust
|
||||
@@ -57,7 +114,7 @@ poetry install
|
||||
### Custom config
|
||||
You can download the example and add your custom rule
|
||||
```
|
||||
wget -O ~/.filedust.conf https://raw.githubusercontent.com/guardutils/filedust/main/.filedust.conf.example
|
||||
wget -O ~/.filedust.conf https://git.sysmd.uk/guardutils/filedust/raw/branch/main/.filedust.conf.example
|
||||
```
|
||||
|
||||
### TAB completion
|
||||
@@ -69,3 +126,13 @@ And then
|
||||
```
|
||||
source ~/.bashrc
|
||||
```
|
||||
|
||||
## pre-commit
|
||||
This project uses [**pre-commit**](https://pre-commit.com/) to run automatic formatting and security checks before each commit (Black, Bandit, and various safety checks).
|
||||
|
||||
To enable it:
|
||||
```
|
||||
poetry install
|
||||
poetry run pre-commit install
|
||||
```
|
||||
This ensures consistent formatting, catches common issues early, and keeps the codebase clean.
|
||||
|
||||
@@ -5,8 +5,8 @@ description = "Opinionated junk cleaner for dev machines (caches, build artifact
|
||||
authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
|
||||
license = "GPL-3.0-or-later"
|
||||
readme = "README.md"
|
||||
homepage = "https://github.com/guardutils/filedust"
|
||||
repository = "https://github.com/guardutils/filedust"
|
||||
homepage = "https://git.sysmd.uk/guardutils/filedust"
|
||||
repository = "https://git.sysmd.uk/guardutils/filedust"
|
||||
packages = [{ include = "filedust", from = "src" }]
|
||||
|
||||
[tool.poetry.dependencies]
|
||||
|
||||
Reference in New Issue
Block a user