diff options
| -rw-r--r-- | posts/quarg.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/posts/quarg.md b/posts/quarg.md new file mode 100644 index 0000000..effb73e --- /dev/null +++ b/posts/quarg.md @@ -0,0 +1,55 @@ +title: quarg - Searching Quassel +date: 2021-05-07 +author: Wolfgang Müller + +## Synopsis + +quarg is a command-line search tool for Quassel. It supports connecting to both +SQLite and PostgreSQL databases and has a wide range of search options. Mostly +born of frustration with Quassel's built-in search, quarg aims to be a simple +and easily extensible search platform. + +**Note:** There are no compatibility guarantees with versions under 1.0.0; +features may change in unexpected and exciting ways. No changelog will be kept +for versions under 1.0.0 either, please consult the commit log instead. + +## Download + +- [quarg-0.1.2.tar.gz](https://git.oriole.systems/quarg/snapshot/quarg-0.1.2.tar.gz) + ([signature](https://git.oriole.systems/quarg/snapshot/quarg-0.1.2.tar.gz.asc), + [verify?](verify-with-signify), + [archive](https://git.oriole.systems/quarg/refs)) +- [Git repository](https://git.oriole.systems/quarg) + +## Requirements + +- [Python](https://www.python.org/) >= 3.8 (with support for SQLite if using the SQLite backend) +- [dateutil](https://dateutil.readthedocs.io/en/stable/parser.html) >= 2.8.1 +- [SQLAlchemy](https://www.sqlalchemy.org/) >= 1.4 +- [psycopg2](https://www.psycopg.org/) (recommended if using the PostgreSQL backend) + +## Usage & Configuration + +See [`quarg(1)`](/man/quarg.1.html). + +You can use quarg without installing it by invoking it like so: + + python -m quarg.main + +## Installation + +quarg uses Python's [setuptools](https://setuptools.readthedocs.io/en/latest/index.html). +To install quarg locally, run: + + python setup.py install --user + +This will put quarg into `~/.local/bin` by default. If you happen to use +Gentoo, feel free to use [the ebuild in my overlay](https://git.oriole.systems/pramantha/tree/net-irc/quarg). + +## Contributing + +I plan to set up a more public venue for proposing changes and reporting issues +with my software. For now, see the [front page](/) for contact info. Feel free +to send patches with +[git-send-email(1)](https://git-scm.com/docs/git-send-email) - see +[here](https://git-send-email.io/) for an intro. |