!!! note
Using a virtual environment is highly recommended. You can spawn one via `pipenv shell`.
- Make sure you're using Python 3.10.x or lower. Otherwise you might
- get issues with building dependencies. You can use
- [pyenv](https://github.com/pyenv/pyenv) to install a specific
- Python version.
5. Install pre-commit hooks:
release at the time of writing. Windows is not and will never be
supported.
+Paperless requires Python 3. At this time, 3.9 - 3.11 are tested versions.
+Newer versions may work, but some dependencies may not fully support newer versions.
+Support for older Python versions may be dropped as they reach end of life or as newer versions
+are released, dependency support is confirmed, etc.
+
1. Install dependencies. Paperless requires the following packages.
- - `python3` - 3.9 - 3.11 are supported
+ - `python3`
- `python3-pip`
- `python3-dev`
- `default-libmysqlclient-dev` for MariaDB
sudo chown paperless:paperless /opt/paperless/consume
```
-8. Install python requirements from the `requirements.txt` file. It is
- up to you if you wish to use a virtual environment or not. First you should update your pip, so it gets the actual packages.
+8. Install python requirements from the `requirements.txt` file.
```shell-session
sudo -Hu paperless pip3 install -r requirements.txt
This will install all python dependencies in the home directory of
the new paperless user.
+ !!! tip
+
+ It is up to you if you wish to use a virtual environment or not for the Python
+ dependencies. This is an alternative to the above and may require adjusting
+ the example scripts to utilize the virtual environment paths
+
9. Go to `/opt/paperless/src`, and execute the following commands:
```bash