https://github.com/bartdorlandt/paperless_email_processor
A processor for parsing files to be send via email and paperless API
https://github.com/bartdorlandt/paperless_email_processor
email paperless receipts
Last synced: 3 months ago
JSON representation
A processor for parsing files to be send via email and paperless API
- Host: GitHub
- URL: https://github.com/bartdorlandt/paperless_email_processor
- Owner: bartdorlandt
- Created: 2025-07-15T19:46:24.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-01-28T13:40:05.000Z (4 months ago)
- Last Synced: 2026-01-29T05:55:33.872Z (4 months ago)
- Topics: email, paperless, receipts
- Language: Python
- Homepage:
- Size: 77.1 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Paperless and Email Processor
With this script you can process files to be send to paperless api or email.
It will check the `process_folder` for files in the `to_paperless`, `to_bookkeeping`, `to_both` or `to_bookkeeper` directories and process them accordingly.
* to_paperless: Files in this folder will be sent to the Paperless API.
* to_bookkeeping: Files in this folder will be sent via email to the bookkeeping application email address to be processed.
* to_both: Files in this folder will be sent to both the Paperless API and via email to the bookkeeping application email address.
* to_bookkeeper: Files in this folder will be sent to my bookkeeper, but could be anyone.
## Requirements
- Python 3.13 or higher
- Required Python packages are specified in `pyproject.toml`
- Environment variables must be set for configuration, see env.example for details.
~~## Docker~~
~~The docker-compose file is provided to run the processor in a Docker container. It mounts the `process_folder` and sets the necessary environment variables.~~
~~It reads the `PROCESS_FOLDER` environment variable to set the main path for processing files.~~
## uv
It used to have a docker setup, with docker-compose and a Dockerfile. The challenge with it and dropbox is the notification to the filesystem when changes happen within the docker. Because of this, the cloud sync on my Synology NAS is not seeing the updates and therefore doesn't sync the files back to dropbox.
Since, I've been using `uv` to run the script directly on my server/nas. This allows for better integration with the filesystem and ensures that changes are detected immediately.
## Possible workflow
1. Use dropbox on your phone for taking pictures of receipts.
2. Drop the file in the desired folder:
- `to_paperless` for paperless processing
- `to_bookkeeping` for bookkeeping processing
- `to_both` for both paperless and bookkeeping processing
3. Have dropbox synced on your server/nas (e.g. Synologoy with cloud sync)
4. Have the script running regularly on your server/nas.
5. The script will process the files in the specified folders and move them to the `done` folder after processing.
## Usage
Provide the main folder along with the environment variables in a `.env` file.
Create a `.env` file based on the `env.example` file and set the required environment variables.
Run `task create_dirs` to create the necessary sub-directories.
Run `task run` to start the script.