https://github.com/friedjof/paperlessscripts
This repository contains scripts to help with some paperless workflows.
https://github.com/friedjof/paperlessscripts
api asn automation documents paperless paperless-ngx
Last synced: 6 months ago
JSON representation
This repository contains scripts to help with some paperless workflows.
- Host: GitHub
- URL: https://github.com/friedjof/paperlessscripts
- Owner: Friedjof
- Created: 2023-12-09T18:16:11.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T00:23:58.000Z (over 1 year ago)
- Last Synced: 2025-02-01T06:24:33.974Z (8 months ago)
- Topics: api, asn, automation, documents, paperless, paperless-ngx
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Paperless Scripts
This repository contains scripts to help with some paperless workflows.
## Installation
### Linux
1. Clone this repository
2. Create a virtual environment: `python -m venv venv`
3. Activate the virtual environment: `source venv/bin/activate`
4. Install the requirements: `pip install -r requirements.txt`
### Windows
1. Clone this repository
2. Create a virtual environment: `python -m venv venv`
3. Activate the virtual environment: `venv\Scripts\activate.bat` or `source venv\Scripts\activate`
4. Install the requirements: `pip install -r requirements.txt`
## Usage
### Generate ASNs
Display the help message for more information:
```bash
python asn/generate.py -h
```
You will finde the generated PDFs in the `asn` folder.
You can visit also the [Makefile](Makefile) for more information about the usage.
#### Sources
1. [Paperless QR-Code ASN](https://margau.net/posts/2023-04-16-paperless-ngx-asn/)
2. [Generate ASN](https://pypi.org/project/paperless-asn-qr-codes/)
3. [Custom ASN script](https://gist.github.com/timrprobocom/3946aca8ab75df8267bbf892a427a1b7/)
### API - Scripts
Manage paperless user defined fields for documenttypes
1. configure config.py and config_documenttypes.py, use *.template if you want an example
2. Initially use organize-doctype-fields to change all existing documents in your paperless instance
3. Regulary use update-open-document-fields.py to update documents with tag "Offen" for defined type fields