{"id":13419542,"url":"https://github.com/rndusr/stig","last_synced_at":"2025-05-16T05:00:29.129Z","repository":{"id":41472455,"uuid":"71486542","full_name":"rndusr/stig","owner":"rndusr","description":"TUI and CLI for the BitTorrent client Transmission","archived":false,"fork":false,"pushed_at":"2025-05-07T09:24:25.000Z","size":4035,"stargazers_count":582,"open_issues_count":47,"forks_count":25,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-05-07T10:34:27.053Z","etag":null,"topics":["asyncio","bittorrent","cli","console","python3","terminal","transmission","transmission-daemon","tui","urwid"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rndusr.png","metadata":{"files":{"readme":"README.org","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-20T17:19:43.000Z","updated_at":"2025-05-07T09:24:29.000Z","dependencies_parsed_at":"2023-12-26T09:08:26.952Z","dependency_job_id":"7f364065-80ad-41d7-8b51-467d7509d34f","html_url":"https://github.com/rndusr/stig","commit_stats":{"total_commits":3446,"total_committers":17,"mean_commits":202.7058823529412,"dds":"0.010446894950667418","last_synced_commit":"16993ab241f3af0e156378dd92925911ffa9a0a6"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rndusr%2Fstig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rndusr%2Fstig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rndusr%2Fstig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rndusr%2Fstig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rndusr","download_url":"https://codeload.github.com/rndusr/stig/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254471028,"owners_count":22076582,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asyncio","bittorrent","cli","console","python3","terminal","transmission","transmission-daemon","tui","urwid"],"created_at":"2024-07-30T22:01:17.463Z","updated_at":"2025-05-16T05:00:29.081Z","avatar_url":"https://github.com/rndusr.png","language":"Python","readme":"* stig\n  [[https://pypi.python.org/pypi/stig][file:https://img.shields.io/pypi/v/stig.svg]]\n  [[file:https://img.shields.io/pypi/status/stig.svg]]\n  [[file:https://img.shields.io/pypi/l/stig.svg]]\n  [[file:https://img.shields.io/pypi/pyversions/stig.svg]]\n  [[file:https://img.shields.io/github/last-commit/rndusr/stig.svg]]\n\n  [[file:https://raw.githubusercontent.com/rndusr/stig/master/screenshot.png]]\n\n  stig is a TUI (text user interface) and CLI (command line interface) client\n  for the [[http://www.transmissionbt.com/][BitTorrent client Transmission]].\n\n  *stig is in maintenance mode.* The code needs to be split it into multiple\n  projects and the current client doesn't really support more clients besides\n  Transmission. *Please don't make any feature PRs.* The more time I invest in\n  reviewing and testing code that is going to be dead, the less time I have for\n  future-proofing stig.\n\n** Features\n   - *Filters* are used to select torrents for listing, starting/stopping,\n     deleting, etc\n   - *Tabs* allow you to open and switch between multiple lists (torrents,\n     peers, files, etc)\n   - *Commands* do almost everything, and they can be invoked\n     - through single- or multi-key (think emacs) *keybindings*,\n     - by entering them in a *command prompt* in the TUI (think vi) with *tab\n       completion*,\n     - by providing them as *CLI arguments* when invoking stig (think git),\n     - or by listing them in an *rc file* which is automatically loaded.\n   - *Color themes* support 16 and 256 colors\n   - *Complete built-in documentation* with ~help~ command or ~--help~ argument\n   - Full *API abstraction layer* makes it possible to add support for other\n     BitTorrent clients with RPC interfaces (contributors are welcome)\n\n** Examples\n   Add two torrents, one by file and one by hash, and exit\n   #+BEGIN_SRC sh\n   $ stig add /path/to/some.torrent d4d6b73851fe3288e40389a8e1fb98124a9b9ba5\n   #+END_SRC\n\n   Connect to non-default host and present the TUI\n   #+BEGIN_SRC sh\n   $ stig set connect.host torrents.local\n   #+END_SRC\n\n   Print all uploading and/or downloading torrents on localhost:9092 and exit\n   #+BEGIN_SRC sh\n   $ stig set connect.port 9092 \\; ls active\n   #+END_SRC\n\n   List torrents with more than 50 seeds, then remove them\n   #+BEGIN_SRC sh\n   $ stig ls 'seeds\u003e50'\n   $ stig rm 'seeds\u003e50'\n   #+END_SRC\n\n   Stop down/uploading torrents with ~/foo/~ in their download path and a ratio\n   above 10\n   #+BEGIN_SRC sh\n   $ stig stop 'path~/foo/\u0026ratio\u003e10'\n   #+END_SRC\n\n   Open two tabs with different torrent lists:\n     - slowly uploading torrents with ~/foo/~ in their download path\n     - small or well-seeded torrents, sorted by size (ascending) and number of\n       seeds (descending)\n   #+BEGIN_SRC sh\n   $ stig tab ls 'path~/foo/\u0026rate-up\u003c10k' \\; tab ls 'size\u003c500M|seeds\u003e=1k' --sort 'size,!seeds'\n   #+END_SRC\n\n** Configuration and Scripting\n   All configuration is done in an rc file, which is just a script containing a\n   list of commands (think vim and .vimrc) that are executed during startup.\n   The default rc file is ~$XDG_CONFIG_HOME/stig/rc~.  ~XDG_CONFIG_HOME~\n   defaults to ~$HOME/.config~ if not set.  Because a default rc file is empty,\n   it is not created automatically to avoid clutter.\n\n   See ~stig help cfgman~ for more information.\n\n*** Example rc file\n    #+BEGIN_SRC\n    # Host that runs Transmission daemon\n    set connect.host example.org\n    set connect.port 123\n\n    # Update torrent/peer/file/etc lists every 10 seconds\n    set tui.poll 10\n\n    # Default columns in torrent lists\n    set columns.torrents name ratio rate-up rate-down\n\n    # Open a few tabs on startup\n    tab ls active --sort !%downloaded,path,!rate\n    tab ls paused --sort !%downloaded --columns name,%downloaded,ratio,size\n    tab ls isolated --sort tracker --columns name,path\n    #+END_SRC\n\n    Run different rc files either with ~stig -c path/to/file~ or with the ~rc~\n    command.  You can even turn them into executables with the shebang\n    ~#!/path/to/stig -Tc~ (~-T~ disables the TUI, ~-c~ specifies the rc file).\n\n*** Example maintenance script\n    #+BEGIN_SRC\n    #!/path/to/stig -Tc\n    rm path=/path/to/torrents/trash\n    pause seeds\u003e100\n    start seeds\u003c20\u0026size\u003e10G|seeds\u003c50\u0026size\u003e20G\n    #+END_SRC\n\n** Installation\n   The [[https://pypi.python.org/pypi/stig][latest release]] is always on PyPI.\n\n*** Packages\n    - Arch (AUR): [[https://aur.archlinux.org/packages/stig][stig]], [[https://aur.archlinux.org/packages/stig-git][stig-git]]\n    - NixOS: [[https://nixos.org/nixos/packages.html?attr=stig\u0026query=stig][stig]]\n    - Alpine Linux: [[https://pkgs.alpinelinux.org/packages?name=stig\u0026branch=edge][stig]]\n\n*** Pipx (recommended)\n    [[https://github.com/pipxproject/pipx][Pipx]] installs applications in self-contained virtual environments in\n    ~$HOME/.local/pipx/~ that include all dependencies.  Executables are\n    sym-linked to ~$HOME/.local/bin/~.\n\n    #+BEGIN_SRC sh\n    $ pipx install stig\n    $ pipx upgrade stig\n    $ pipx uninstall stig\n    #+END_SRC\n\n*** Pip\n    [[https://pip.pypa.io/en/stable/][pip]] installs applications with their dependencies in the system-wide\n    (~/usr/local~) or user-wide (~$HOME/.local~) environment.\n\n    #+BEGIN_SRC sh\n    $ pip3 install stig         # Installs in /usr/local/\n    $ pip3 install --user stig  # Installs in $HOME/.local/\n    #+END_SRC\n\n    To update, add the ~--upgrade~ or ~-U~ option.\n\n*** Extras\n    The following extras are available to enable optional features:\n    - ~setproctitle~ :: Strip arguments from process title when running in tmux\n                        session (this requires Python headers; e.g.\n                        ~apt-get install libpython3-dev~)\n    - ~proxy~ :: Tunnel the connection to the Transmission daemon through a\n                 SOCKS5, SOCKS4 or HTTP proxy\n\n    To install stig with dependencies for an extra:\n    #+BEGIN_SRC sh\n    $ pipx install 'stig[setproctitle,proxy]'              # For pipx version\u003e=0.15.0.0\n    $ pipx install stig --spec 'stig[setproctitle,proxy]'  # For pipx version\u003c0.15.0.0\n    #+END_SRC\n\n*** Development version\n    To install the latest development version of stig with pipx:\n    #+BEGIN_SRC sh\n    $ pipx install 'git+https://github.com/rndusr/stig.git#egg=stig'              # For pipx version\u003e=0.15.0.0\n    $ pipx install stig --spec 'git+https://github.com/rndusr/stig.git#egg=stig'  # For pipx version\u003c0.15.0.0\n    #+END_SRC\n\n*** Developing\n    To make your code changes effective immediately, you can either run\n    ~python3 -m stig \u003cARGUMENTS\u003e~ in the project directory or use ~pip3~'s\n    ~--editable~ option.\n\n**** Run tests with your system's Python version\n     To run the tests with the Python version that is installed on your system,\n     simply run ~make test~ in the project directory.  This creates a virtual\n     environment in ~./venv~, installs stig and its dependencies in there and\n     runs all tests.\n\n     If you want to only run tests for a specific module or package:\n\n     1. Create a virtual environment with all dependencies:\n        ~make venv~\n     2. Activate the virtual environment:\n        ~source venv/bin/activate~\n     3. Pass any path in the ~tests~ directory to pytest:\n        ~pytest tests/settings_test~\n\n**** Run tests with all supported Python versions\n     1. Install and set up [[https://github.com/pyenv/pyenv#table-of-contents][pyenv]].\n     2. With pyenv, install the supported Python versions listed in\n        ~.setup.py~.\n     3. In stig's project directory, create a virtual environment with all\n        dependencies: ~make venv~\n     4. Activate the virtual environment:\n        ~source venv/bin/activate~\n     5. Run the tests for each supported Python version:\n        ~tox~\n     6. Pass arguments to pytest:\n        ~tox -- --exitfirst tests/settings_test~\n\n** Requirements\n   - Python \u003e=3.6\n   - [[http://www.urwid.org/][urwid]] \u003e=1.3.0\n   - [[https://github.com/pazz/urwidtrees][urwidtrees]] \u003e=1.0.3dev0\n   - [[https://pypi.python.org/pypi/aiohttp][aiohttp]]\n   - [[https://pypi.python.org/pypi/async_timeout][async_timeout]]\n   - [[https://pypi.python.org/pypi/pyxdg][pyxdg]]\n   - [[https://pypi.python.org/pypi/blinker][blinker]]\n   - [[https://pypi.python.org/pypi/natsort][natsort]]\n   - [[https://pypi.python.org/pypi/setproctitle/1.1.10][setproctitle]] (optional; prettifies the process name)\n   - [[https://pypi.python.org/pypi/asynctest/][asynctest]] (only needed to run tests)\n\n** Contributing\n   Pull requests, bug reports, features requests, ideas for improvement and all\n   other constructive contributions are welcome.\n\n   If you want to contribute code and get stuck, don't know where to even begin,\n   or just to make sure you're not duplicating someone else's efforts, open an\n   issue.\n\n   Please submit your custom themes if you would like them to be included in\n   stig.\n\n** License\n   stig is free software: you can redistribute it and/or modify it under the\n   terms of the GNU General Public License as published by the Free Software\n   Foundation, either version 3 of the License, or (at your option) any later\n   version.\n\n   This program is distributed in the hope that it will be useful but WITHOUT\n   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\n   FOR A PARTICULAR PURPOSE.  See the [[https://www.gnu.org/licenses/gpl-3.0.txt][GNU General Public License]] for more\n   details.\n\n#+STARTUP: showeverything\n#+OPTIONS: num:nil\n#+OPTIONS: ^:{}\n","funding_links":[],"categories":["Python","Misc","\u003ca name=\"torrent\"\u003e\u003c/a\u003eTorrent"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frndusr%2Fstig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frndusr%2Fstig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frndusr%2Fstig/lists"}