mirror of
				https://github.com/paperless-ngx/paperless-ngx.git
				synced 2025-11-03 19:17:13 -05:00 
			
		
		
		
	Documentation: Corrections and clarifications for Python support (#6995)
* Clarifies Python version support and a rough policy of what versions are supported
This commit is contained in:
		
							parent
							
								
									22a6360edf
								
							
						
					
					
						commit
						28db7e84e6
					
				@ -11,7 +11,7 @@ If you want to implement something big:
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Python
 | 
					## Python
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Paperless supports python 3.9 - 3.11. We format Python code with [ruff](https://docs.astral.sh/ruff/formatter/).
 | 
					Paperless supports python 3.9 - 3.11 at this time. We format Python code with [ruff](https://docs.astral.sh/ruff/formatter/).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Branches
 | 
					## Branches
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -81,10 +81,6 @@ first-time setup.
 | 
				
			|||||||
    !!! note
 | 
					    !!! note
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        Using a virtual environment is highly recommended. You can spawn one via `pipenv shell`.
 | 
					        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:
 | 
					5.  Install pre-commit hooks:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -250,9 +250,14 @@ a minimal installation of Debian/Buster, which is the current stable
 | 
				
			|||||||
release at the time of writing. Windows is not and will never be
 | 
					release at the time of writing. Windows is not and will never be
 | 
				
			||||||
supported.
 | 
					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.
 | 
					1.  Install dependencies. Paperless requires the following packages.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    - `python3` - 3.9 - 3.11 are supported
 | 
					    - `python3`
 | 
				
			||||||
    - `python3-pip`
 | 
					    - `python3-pip`
 | 
				
			||||||
    - `python3-dev`
 | 
					    - `python3-dev`
 | 
				
			||||||
    - `default-libmysqlclient-dev` for MariaDB
 | 
					    - `default-libmysqlclient-dev` for MariaDB
 | 
				
			||||||
@ -410,8 +415,7 @@ supported.
 | 
				
			|||||||
    sudo chown paperless:paperless /opt/paperless/consume
 | 
					    sudo chown paperless:paperless /opt/paperless/consume
 | 
				
			||||||
    ```
 | 
					    ```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
8.  Install python requirements from the `requirements.txt` file. It is
 | 
					8.  Install python requirements from the `requirements.txt` file.
 | 
				
			||||||
    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.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
    ```shell-session
 | 
					    ```shell-session
 | 
				
			||||||
    sudo -Hu paperless pip3 install -r requirements.txt
 | 
					    sudo -Hu paperless pip3 install -r requirements.txt
 | 
				
			||||||
@ -420,6 +424,12 @@ supported.
 | 
				
			|||||||
    This will install all python dependencies in the home directory of
 | 
					    This will install all python dependencies in the home directory of
 | 
				
			||||||
    the new paperless user.
 | 
					    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:
 | 
					9.  Go to `/opt/paperless/src`, and execute the following commands:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    ```bash
 | 
					    ```bash
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user