path: root/posts/quarg.md

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.

quarg is written in [Python](https://www.python.org/), enabling it to work on a
variety of operating systems. It has successfully been tested on Linux as well
as Windows machines.

## Download

- [quarg-1.0.0.tar.gz](https://git.oriole.systems/quarg/snapshot/quarg-1.0.0.tar.gz)
	([signature](https://git.oriole.systems/quarg/snapshot/quarg-1.0.0.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.2
- [SQLAlchemy](https://www.sqlalchemy.org/) >= 2.0
- [psycopg](https://www.psycopg.org/) (recommended if using the PostgreSQL backend)

## Usage & Configuration

See [`quarg(1)`](https://git.oriole.systems/quarg/about/quarg.1).

## Installation

First, create a [virtual
environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/)
and activate it.

    python -m venv venv
    source .venv/bin/activate

Now you can install the downloaded tarball with pip:

	python -m pip install quarg-1.0.0.tar.gz

Remember to make sure you install psycopg if you intend to use the PostgreSQL
backend:

    python -m pip install psycopg

quarg should now be available in your shell:

    quarg -h

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-scm.com/docs/MyFirstContribution#howto-git-send-email) and
[here](https://git-send-email.io/) for an intro.