Project Patterns

How the project is organized

Directory structure	Description
├── alembic	database migration for SQLAlchemy
│   └── versions	database migrations
├── changelog.md	list of changes for each release
├── CODE_OF_CONDUCT.md	community code of conduct
├── create_dev_data.py	creates local db and config for test
├── files	files to create qubes-client exe
├── LICENSE	license file
├── Makefile	build automation
├── MANIFEST.in	files to include in sdist
├── pyproject.toml	code formatting configuration
├── requirements	list of dependencies to pip install
├── run.sh	script to run the client for test
├── securedrop_client	client application code
│   ├── api_jobs	queue jobs that make api requests
│   ├── app.py	creates & configures the application
│   ├── config.py	creates config file in homedir
│   ├── crypto.py	decrypts messages, encrypts replies
│   ├── database.py	representation of db
│   ├── db.py	sqlalchemy models
│   ├── export.py	exports files to qubes sd-devices vm
│   ├── gui	gui for the application
│   ├── __init__.py	contains the application version
│   ├── logic.py	controller, manage auth, networking
│   ├── main.py	TK
│   ├── queue.py	network operations queue class
│ ├── utils.py	safer calls to mkdir, untar etc
│ ├── storage.py	database actions
│   ├── resources	TK
│   │ ├── css	css files used to style the gui
│   │ └── images	TK
│   └── state	TK
│   ├── domain.py	TK
│   └── state.py	TK
├── setup.cfg	TK
├── setup.py	setuptools pkging config
├── svs.sqlite	database holding client content
├── test-functional.sh	randomize & run functional tests
├── tests	test suite
│ ├── api_jobs	test networking actions
│ ├── files	sample files used in testing
│ ├── functional	functional tests
│ │   └── cassettes	vcr mock network calls for testing
│ ├── gui	GUI testing
│ └── integration	GUI integration tests
└── update-version.sh	bump version in setup and config