blob: ab2f5a216f49f466dabe363a049cfb5e3ae84514 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
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.
**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 <args>
## 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. You can also use pip to
automatically pull in any unmet dependencies:
pip install --user .
Finally, 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.
|
