summaryrefslogtreecommitdiffstatshomepage
path: root/posts
diff options
context:
space:
mode:
Diffstat (limited to 'posts')
-rw-r--r--posts/quarg.md41
1 files changed, 22 insertions, 19 deletions
diff --git a/posts/quarg.md b/posts/quarg.md
index c27d77a..0a091a5 100644
--- a/posts/quarg.md
+++ b/posts/quarg.md
@@ -13,14 +13,10 @@ 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.2.0.tar.gz](https://git.oriole.systems/quarg/snapshot/quarg-0.2.0.tar.gz)
- ([signature](https://git.oriole.systems/quarg/snapshot/quarg-0.2.0.tar.gz.asc),
+- [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)
@@ -28,31 +24,38 @@ for versions under 1.0.0 either, please consult the commit log instead.
## 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)
+- [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).
-You can use quarg without installing it by invoking it like so:
+## Installation
- python -m quarg.main <args>
+First, create a [virtual
+environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/)
+and activate it.
-## Installation
+ 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
-quarg uses Python's [setuptools](https://setuptools.readthedocs.io/en/latest/index.html).
-To install quarg locally, run:
+Remember to make sure you install psycopg if you intend to use the PostgreSQL
+backend:
- python setup.py install --user
+ python -m pip install psycopg
-This will put quarg into `~/.local/bin` by default. You can also use pip to
-automatically pull in any unmet dependencies:
+quarg should now be available in your shell:
- pip install --user .
+ quarg -h
-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).
+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