Increased flexibility and privacy.

This commit is contained in:
lwark
2024-07-25 14:42:18 -05:00
parent 4bc5e08ac6
commit 2a34f855aa
6 changed files with 172 additions and 19 deletions

View File

@@ -113,13 +113,26 @@ This is meant to import .xslx files created from the Design & Analysis Software
## SETUP:
## Download:
*Python v3.11 or greater must be installed on your system for this.*
1. Clone or download from github.
2. Enter the downloaded folder.
3. Open a terminal in the folder with the 'src' folder.
4. Create a new virtual environment: ```python -m venv venv```
5. Activate the virtual environment: (Windows) ```venv\Scripts\activate.bat```
6. Install dependencies: ```pip install -r requirements.txt```
## Database:
1. Copy 'alembic_default.ini' to 'alembic.ini' in the same folder.
2. Open 'alembic.ini' and edit 'sqlalchemy.url' to the desired path of the database.
1. The path by default is sqlite based. Postgresql support is available.
2. Postgres path
3. Open a terminal in the folder with the 'src' folder.
4. Run database migration: ```alembic upgrade head```
## First Run:
1. On first run, the application copies src/config.yml to C:\Users\{USERNAME}\Local\submissions\config
2. Initially, the 'directory_path' variable is set to the 'sqlalchemy.url' variable in alembic.ini
3. If this folder cannot be found, C:\Users\{USERNAME}\Documents\submissions will be used.
1. If using Postgres, the 'database_path' and other variables will have to be updated manually.