Skip to content

Project Patterns

Allie Crevier edited this page Jul 21, 2020 · 5 revisions

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
β”‚Β Β  β”œβ”€β”€ 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 TK
β”‚Β Β  β”œβ”€β”€ main.py TK
β”‚Β Β  β”œβ”€β”€ queue.py TK
β”‚Β Β  └── resources TK
β”‚Β Β  β”œβ”€β”€ css css files used to style the gui
β”‚Β Β  β”œβ”€β”€ fonts TK
β”‚Β Β  └── images TK
β”œβ”€β”€ setup.cfg TK
β”œβ”€β”€ setup.py TK
β”œβ”€β”€ svs.sqlite TK
β”œβ”€β”€ test-functional.sh TK
└── tests TK
β”œβ”€β”€ api_jobs TK
β”œβ”€β”€ files TK
β”œβ”€β”€ functional TK
β”‚Β Β  └── cassettes TK
β”œβ”€β”€ gui TK
└── integration TK
Clone this wiki locally