- Using the contatct list app.
- Design documentation.
- Language: Python v3.9.5
- Python Packages:
pip install -r requirements.txt - Database: SQLite v3.36.0
- GUI Framework: PyQT5
- OS Compatibility: *nix (MacOSX/Linux)
- Miscellaneous:
pipreqsto generate requirements file without extraneous specspandocfor usingdocument_gen.sh
NOTE: Find detailed docs in ./docs
- Setup a Python 3.9.5+ environment
- Install requirements file
- Create folder
src/generated_views - Change the interpreter path in
build.shto your local environment. - Change the database paths in
src/config.pyto your local database location & csv file location. - Run
build.shusingbash build.sh- Builds the python files for UI files in
./uiand stores them insrc/generated_viewsif run within a virtual environment withpyuic5available, else skips this step. - Runs
python3 create_db.pyto create the database - Runs
define_text_search.sqlto create a virtual table using FTS5, a module which affords full text-search capabilities in SQLite DBs. - Runs
populate_text_search.sqlwhich populates the text search virtual table with the values already present in the table. - Runs
triggers.sqlwhich adds triggers to all the contact list tables such that any CRUD operation on them is replicated & the text search table index is synchronized.
- Builds the python files for UI files in
- Running
main.pylaunches the GUI application - Find GUI instructions in the
Quickstart Guide