stig [[https://pypi.python.org/pypi/stig][file:https://img.shields.io/pypi/v/stig.svg]] [[file:https://img.shields.io/pypi/status/stig.svg]] [[file:https://img.shields.io/pypi/l/stig.svg]] [[file:https://img.shields.io/pypi/pyversions/stig.svg]] [[file:https://img.shields.io/github/last-commit/rndusr/stig.svg]]
[[file:https://raw.githubusercontent.com/rndusr/stig/master/screenshot.png]]
stig is a TUI (text user interface) and CLI (command line interface) client for the [[http://www.transmissionbt.com/][BitTorrent client Transmission]].
stig is in maintenance mode. The code needs to be split it into multiple projects and the current client doesn't really support more clients besides Transmission. Please don't make any feature PRs. The more time I invest in reviewing and testing code that is going to be dead, the less time I have for future-proofing stig.
** Features
** Examples Add two torrents, one by file and one by hash, and exit
$ stig add /path/to/some.torrent d4d6b73851fe3288e40389a8e1fb98124a9b9ba5
Connect to non-default host and present the TUI
$ stig set connect.host torrents.local
Print all uploading and/or downloading torrents on localhost:9092 and exit
$ stig set connect.port 9092 \; ls active
List torrents with more than 50 seeds, then remove them
$ stig ls 'seeds>50' $ stig rm 'seeds>50'
Stop down/uploading torrents with ~/foo/~ in their download path and a ratio above 10
$ stig stop 'path~/foo/&ratio>10'
Open two tabs with different torrent lists:
$ stig tab ls 'path~/foo/&rate-up<10k' \; tab ls 'size<500M|seeds>=1k' --sort 'size,!seeds'
** Configuration and Scripting All configuration is done in an rc file, which is just a script containing a list of commands (think vim and .vimrc) that are executed during startup. The default rc file is ~$XDG_CONFIG_HOME/stig/rc~. ~XDG_CONFIG_HOME~ defaults to ~$HOME/.config~ if not set. Because a default rc file is empty, it is not created automatically to avoid clutter.
See ~stig help cfgman~ for more information.
*** Example rc file
# Host that runs Transmission daemon
set connect.host example.org
set connect.port 123
# Update torrent/peer/file/etc lists every 10 seconds
set tui.poll 10
# Default columns in torrent lists
set columns.torrents name ratio rate-up rate-down
# Open a few tabs on startup
tab ls active --sort !%downloaded,path,!rate
tab ls paused --sort !%downloaded --columns name,%downloaded,ratio,size
tab ls isolated --sort tracker --columns name,path
#+END_SRC
Run different rc files either with ~stig -c path/to/file~ or with the ~rc~
command. You can even turn them into executables with the shebang
~#!/path/to/stig -Tc~ (~-T~ disables the TUI, ~-c~ specifies the rc file).*** Example maintenance script
#!/path/to/stig -Tc
rm path=/path/to/torrents/trash
pause seeds>100
start seeds<20&size>10G|seeds<50&size>20G
#+END_SRC** Installation The [[https://pypi.python.org/pypi/stig][latest release]] is always on PyPI.
*** Packages
*** Pipx (recommended) [[https://github.com/pipxproject/pipx][Pipx]] installs applications in self-contained virtual environments in ~$HOME/.local/pipx/~ that include all dependencies. Executables are sym-linked to ~$HOME/.local/bin/~.
#+BEGIN_SRC sh
$ pipx install stig
$ pipx upgrade stig
$ pipx uninstall stig
#+END_SRC*** Pip [[https://pip.pypa.io/en/stable/][pip]] installs applications with their dependencies in the system-wide (~/usr/local~) or user-wide (~$HOME/.local~) environment.
#+BEGIN_SRC sh
$ pip3 install stig # Installs in /usr/local/
$ pip3 install --user stig # Installs in $HOME/.local/
#+END_SRC
To update, add the ~--upgrade~ or ~-U~ option.*** Extras The following extras are available to enable optional features:
~proxy~ :: Tunnel the connection to the Transmission daemon through a SOCKS5, SOCKS4 or HTTP proxy
To install stig with dependencies for an extra:
$ pipx install 'stig[setproctitle,proxy]' # For pipx version>=0.15.0.0 $ pipx install stig --spec 'stig[setproctitle,proxy]' # For pipx version<0.15.0.0
*** Development version To install the latest development version of stig with pipx:
$ pipx install 'git+https://github.com/rndusr/stig.git#egg=stig' # For pipx version>=0.15.0.0
$ pipx install stig --spec 'git+https://github.com/rndusr/stig.git#egg=stig' # For pipx version<0.15.0.0
#+END_SRC*** Developing
To make your code changes effective immediately, you can either run
~python3 -m stig
**** Run tests with your system's Python version To run the tests with the Python version that is installed on your system, simply run ~make test~ in the project directory. This creates a virtual environment in ~./venv~, installs stig and its dependencies in there and runs all tests.
If you want to only run tests for a specific module or package:
1. Create a virtual environment with all dependencies:
~make venv~
2. Activate the virtual environment:
~source venv/bin/activate~
3. Pass any path in the ~tests~ directory to pytest:
~pytest tests/settings_test~**** Run tests with all supported Python versions
** Requirements
** Contributing Pull requests, bug reports, features requests, ideas for improvement and all other constructive contributions are welcome.
If you want to contribute code and get stuck, don't know where to even begin, or just to make sure you're not duplicating someone else's efforts, open an issue.
Please submit your custom themes if you would like them to be included in stig.
** License stig is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [[https://www.gnu.org/licenses/gpl-3.0.txt][GNU General Public License]] for more details.