Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chapmanjacobd committed Dec 13, 2024
1 parent 297cb98 commit bd143d4
Show file tree
Hide file tree
Showing 3 changed files with 105 additions and 100 deletions.
35 changes: 21 additions & 14 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tracking online video playlists (eg. YouTube subscriptions) and scheduling brows

Linux recommended but [Windows setup instructions](./Windows.md) available.

pip install xklb
pip install library

Should also work on Mac OS.

Expand Down Expand Up @@ -99,7 +99,7 @@ To stop playing press Ctrl+C in either the terminal or mpv
<details><summary>List all subcommands</summary>

$ library
library (v3.0.032; 99 subcommands)
library (v3.0.034; 99 subcommands)

Create database subcommands:
╭─────────────────┬──────────────────────────────────────────╮
Expand Down Expand Up @@ -419,7 +419,7 @@ Or with `systemd`:

tee ~/.config/systemd/user/tabs.service
[Unit]
Description=xklb daily browser tabs
Description=library daily browser tabs

[Service]
Type=simple
Expand All @@ -429,7 +429,7 @@ Or with `systemd`:

tee ~/.config/systemd/user/tabs.timer
[Unit]
Description=xklb daily browser tabs timer
Description=library daily browser tabs timer

[Timer]
Persistent=yes
Expand Down Expand Up @@ -784,7 +784,7 @@ BTW, for some cols like time_deleted you'll need to specify a where clause so th

IRIs vs URLs

XKLB should:
Library should:
- print paths as unquoted UTF-8 IRIs (by default)
- accept either IRIs or URLs as input with optional flags to make parsing/searching explicitly use one or the other
- save paths to the database "AS-IS"
Expand Down Expand Up @@ -1004,6 +1004,13 @@ BTW, for some cols like time_deleted you'll need to specify a where clause so th

library torrents-add torrents.db ~/.local/data/qbittorrent/queue/

View total size of undownloaded torrents

library playlists torrents.db -pa
path deleted_count size playlists_count media_count
---------------------- --------------- -------- ----------------- -------------
Aggregate of playlists 0 87.7 TiB 530 272681


</details>

Expand Down Expand Up @@ -1162,9 +1169,9 @@ BTW, for some cols like time_deleted you'll need to specify a where clause so th

Expand search URLs with multiple queries

library expand-links -s https://www.google.com/search?q=%s -s https://duckduckgo.com/?q=%s xklb
https://www.google.com/search?q=xklb
https://duckduckgo.com/?q=xklb
library expand-links -s https://www.google.com/search?q=%s -s https://duckduckgo.com/?q=%s library
https://www.google.com/search?q=library
https://duckduckgo.com/?q=library

library expand-links -s https://www.walmart.com/search?q=%s -s https://www.target.com/s?searchTerm=%s "Dr. Pepper" pepcidine
https://www.walmart.com/search?q=Dr%20Pepper
Expand Down Expand Up @@ -1454,11 +1461,11 @@ BTW, for some cols like time_deleted you'll need to specify a where clause so th
Free up space on a specific disk. Find candidates for moving data to a different mount point


The program takes a mount point and a xklb database file. If you don't have a database file you can create one like this
The program takes a mount point and a library database file. If you don't have a database file you can create one like this

library fsadd --filesystem d.db ~/d/

But this should definitely also work with xklb audio and video databases
But this should definitely also work with library audio and video databases

library mv-list /mnt/d/ video.db

Expand Down Expand Up @@ -2141,7 +2148,7 @@ Inspired somewhat by https://nikkhokkho.sourceforge.io/?page=FileOptimizer
usage: library torrents-stop

Stop torrents in qBittorrent-nox with the following defaults:
- tagged 'xklb'
- tagged 'library'
- >180 days active seeding
- >90 days since last peer
- >3 current seeders
Expand All @@ -2151,7 +2158,7 @@ Inspired somewhat by https://nikkhokkho.sourceforge.io/?page=FileOptimizer

library torrents-stop --min-seeders 3 --min-days-stalled-seed 10 --min-days-seeding 14

When --mark-deleted is provided, the torrents are tagged with 'xklb-delete' in qBittorrent
When --mark-deleted is provided, the torrents are tagged with 'library-delete' in qBittorrent
When --delete-rows is provided, the metadata is removed from qBittorrent
When --delete-files is provided, the downloaded files are deleted

Expand All @@ -2166,7 +2173,7 @@ Inspired somewhat by https://nikkhokkho.sourceforge.io/?page=FileOptimizer
usage: library torrents-stop-incomplete

Stop torrents in qBittorrent-nox with the following defaults:
- tagged 'xklb'
- tagged 'library'
- >90 days since last seen complete (or never)
- >60 days active downloading
- >30 days since last peer (or never)
Expand All @@ -2175,7 +2182,7 @@ Inspired somewhat by https://nikkhokkho.sourceforge.io/?page=FileOptimizer

library torrents-stop --min-days-downloading 7

When --mark-deleted is provided, the torrents are tagged with 'xklb-delete' in qBittorrent
When --mark-deleted is provided, the torrents are tagged with 'library-delete' in qBittorrent
When --delete-rows is provided, the metadata is removed from qBittorrent
When --delete-files is provided, all downloaded files are deleted.
By default, salvage is provided to files which have more than 73% progress.
Expand Down
2 changes: 1 addition & 1 deletion library/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from library.utils import argparse_utils, iterables
from library.utils.log_utils import log

__version__ = "3.0.033"
__version__ = "3.0.034"

progs = {
"Create database subcommands": {
Expand Down
Loading

0 comments on commit bd143d4

Please sign in to comment.