Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
67a6af2ddb
|
|||
| 25ea1fec63 | |||
|
dc66700f1e
|
|||
| 1eb082fc52 | |||
|
c2f52b8049
|
|||
|
6ebef8e058
|
|||
|
|
fca4c8defc | ||
| 6cdfd2fc44 | |||
|
6c1d2dc430
|
@@ -20,7 +20,7 @@ jobs:
|
|||||||
run: pip install pre-commit
|
run: pip install pre-commit
|
||||||
|
|
||||||
- name: Run pre-commit hooks
|
- name: Run pre-commit hooks
|
||||||
uses: pre-commit/action@v3.0.1
|
run: pre-commit run --all-files --color always
|
||||||
|
|
||||||
- name: Install pip-audit
|
- name: Install pip-audit
|
||||||
run: pip install pip-audit
|
run: pip install pip-audit
|
||||||
77
README.md
77
README.md
@@ -1,8 +1,6 @@
|
|||||||
[](LICENCE)
|
[](https://git.sysmd.uk/guardutils/filedust/src/branch/main/LICENCE)
|
||||||
[](https://github.com/guardutils/filedust/)
|
[](https://git.sysmd.uk/guardutils/filedust/releases)
|
||||||

|
[](https://git.sysmd.uk/guardutils/filedust/src/branch/main/.pre-commit-config.yaml)
|
||||||

|
|
||||||
[](https://pypi.org/project/filedust/)
|
|
||||||
|
|
||||||
# filedust
|
# filedust
|
||||||
|
|
||||||
@@ -42,6 +40,63 @@ Shows how much disk space can be freed.
|
|||||||
|
|
||||||
## Installation
|
## 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/guardutils/debian stable 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/guardutils/rpm/$basearch
|
||||||
|
enabled=1
|
||||||
|
gpgcheck=1
|
||||||
|
repo_gpgcheck=1
|
||||||
|
gpgkey=https://repo.sysmd.uk/guardutils/guardutils.gpg
|
||||||
|
EOF
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 4) Update and install
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo dnf upgrade --refresh
|
||||||
|
sudo dnf install filedust
|
||||||
|
```
|
||||||
|
|
||||||
### From PyPI
|
### From PyPI
|
||||||
```
|
```
|
||||||
pip install filedust
|
pip install filedust
|
||||||
@@ -57,7 +112,7 @@ poetry install
|
|||||||
### Custom config
|
### Custom config
|
||||||
You can download the example and add your custom rule
|
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
|
### TAB completion
|
||||||
@@ -69,3 +124,13 @@ And then
|
|||||||
```
|
```
|
||||||
source ~/.bashrc
|
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.
|
||||||
|
|||||||
2
poetry.lock
generated
2
poetry.lock
generated
@@ -555,4 +555,4 @@ test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess
|
|||||||
[metadata]
|
[metadata]
|
||||||
lock-version = "2.0"
|
lock-version = "2.0"
|
||||||
python-versions = ">=3.10,<4.0"
|
python-versions = ">=3.10,<4.0"
|
||||||
content-hash = "676393f654b241eb2ea6f983d589e83daff16e0b0ca2cb76228c0cd5ed447591"
|
content-hash = "5ffc6940e33919ad5c8107dde30e6203d63a3bb64eaab81013cde2e773964657"
|
||||||
|
|||||||
@@ -1,18 +1,18 @@
|
|||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "filedust"
|
name = "filedust"
|
||||||
version = "0.3.0"
|
version = "0.3.1"
|
||||||
description = "Opinionated junk cleaner for dev machines (caches, build artifacts, editor backups)."
|
description = "Opinionated junk cleaner for dev machines (caches, build artifacts, editor backups)."
|
||||||
authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
|
authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
|
||||||
license = "GPL-3.0-or-later"
|
license = "GPL-3.0-or-later"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
homepage = "https://github.com/guardutils/filedust"
|
homepage = "https://git.sysmd.uk/guardutils/filedust"
|
||||||
repository = "https://github.com/guardutils/filedust"
|
repository = "https://git.sysmd.uk/guardutils/filedust"
|
||||||
packages = [{ include = "filedust", from = "src" }]
|
packages = [{ include = "filedust", from = "src" }]
|
||||||
|
|
||||||
[tool.poetry.dependencies]
|
[tool.poetry.dependencies]
|
||||||
python = ">=3.10,<4.0"
|
python = ">=3.10,<4.0"
|
||||||
rich = "^13.0.0"
|
rich = ">=12"
|
||||||
argcomplete = "^3.3.0"
|
argcomplete = ">=2"
|
||||||
|
|
||||||
[tool.poetry.scripts]
|
[tool.poetry.scripts]
|
||||||
filedust = "filedust.cli:main"
|
filedust = "filedust.cli:main"
|
||||||
|
|||||||
@@ -168,7 +168,6 @@ def delete_all(findings: List[Finding]) -> int:
|
|||||||
|
|
||||||
|
|
||||||
def main(argv: list[str] | None = None) -> int:
|
def main(argv: list[str] | None = None) -> int:
|
||||||
print("Looking for junk ...")
|
|
||||||
parser = build_parser()
|
parser = build_parser()
|
||||||
args = parser.parse_args(argv)
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
@@ -191,6 +190,8 @@ def main(argv: list[str] | None = None) -> int:
|
|||||||
console.print(f"[red]Error:[/] Path not found: {root}")
|
console.print(f"[red]Error:[/] Path not found: {root}")
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
|
print("Looking for junk ...")
|
||||||
|
|
||||||
if root.resolve() == Path("/"):
|
if root.resolve() == Path("/"):
|
||||||
console.print(
|
console.print(
|
||||||
"[yellow]Running filedust on the entire filesystem (/). "
|
"[yellow]Running filedust on the entire filesystem (/). "
|
||||||
|
|||||||
Reference in New Issue
Block a user