paperhooks

module
v0.0.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 8, 2024 License: BSD-3-Clause

README

Client and hook toolkit for Paperless-ngx

Latest release CI workflow Go reference

Paperhooks is a toolkit for writing consumption hooks for Paperless-ngx written using the Go programming language. A REST API client is part of the toolkit (pkg/client).

Paperless-ngx is a document management system transforming physical documents into a searchable online archive.

Run integration tests

Integration tests execute operations against a real Paperless-ngx server running in a Docker container. The wrapper script enables destructive tests and should not be run against a production instance.

Commands:

env --chdir contrib/integration-env docker-compose up

contrib/run-integration

Directories

Path Synopsis
example
internal
pkg
client
Package client implements the [REST API] exposed by [Paperless-ngx].
Package client implements the [REST API] exposed by [Paperless-ngx].

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL