A collection manager.
Project description
Hector — a collection manager
Install
For the time being, Hector cannot be installed from PyPI. See CONTRIBUTING.md to set up a development environment.
Configure
Hector is configured using environment variables.
All the variable names are prefixed with HECTOR_
.
$ export HECTOR_SECRET_KEY="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
$ export HECTOR_DSN="sqlite:///data.sqlite"
The secret can be generated using the token_hex()
function from
the Python's secrets
module.
Additional Python database drivers might be required depending on the DSN.
See the settings
module for
a comprehensive list of configuration variables.
Authentication
To enable WebAuthn authentication, you must install extra dependencies (bl-hector[webauthn]
)
and enable it explicitly:
$ export HECTOR_WEBAUTHN=1
To enable TOTP authentication, you must install extra dependencies (bl-hector[totp]
)
and enable it explicitly by setting a base32 random secret (pyotp.random_base32()
):
$ export HECTOR_TOTP=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Initialise
Once configured, you must initialise Hector's database with the dedicated command:
$ hector init-db
Run
Hector being a Flask application, it can be run using any WSGI server, for instance, with Gunicorn:
$ gunicorn --access-logfile="-" -w 4 -b 127.0.0.1:3000 "bl_hector.configuration.wsgi:app()"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bl_hector-0.1.0a7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 782e4e0458e7e5b6e55c94756ee81996876ca2665ae4337a8a68101a91ec04d6 |
|
MD5 | b05cc2bba37d49ef1fa7509351b76d14 |
|
BLAKE2b-256 | c0dd6b226708ac88e7eca0ebc603c0e82924663ba2e14b2bf29bb370aa744789 |