diff --git a/.gitignore b/.gitignore index a1a390b..7d222f0 100644 --- a/.gitignore +++ b/.gitignore @@ -45,3 +45,5 @@ go.work.sum /qldbminio/qldb .ipynb_checkpoints/ venv/ +*.egg-info +__pycache__ diff --git a/README.md b/README.md index d0edfed..0125dfe 100644 --- a/README.md +++ b/README.md @@ -15,31 +15,7 @@ Separate from the server's downloading of databases, a client-side interface is 3. is session based to allow iterations on selection / narrowing 4. must be queryable. There is no need to reinvent sql / dataframes -Python with dataframes is ideal for this. - -- Set up the virtual environment and install tools - - cd ~/work-gh/mrva/mrvacommander/client - python3.11 -m venv venv - source venv/bin/activate - pip install --upgrade pip - pip install jupyterlab pandas ipython - pip install lckr-jupyterlab-variableinspector - -- Run jupyterlab - - cd ~/work-gh/mrva/mrvacommander/client - source venv/bin/activate - jupyter lab & - - The variable inspector is a right-click on an open console or notebook. - - The `jupyter` command produces output including - - Jupyter Server 2.14.1 is running at: - http://127.0.0.1:8888/lab?token=4c91308819786fe00a33b76e60f3321840283486457516a1 - - Use this to connect multiple front ends +Python with dataframes is ideal for this; the project is in `client/`. ## Reverse proxy For testing, replay flows using mitmweb. This is faster and simpler than using diff --git a/client/qldbtools/README.md b/client/qldbtools/README.md index 8d250df..6db732a 100644 --- a/client/qldbtools/README.md +++ b/client/qldbtools/README.md @@ -4,18 +4,46 @@ qldbtools is a Python package for working with CodeQL databases ## Installation -Local development +- Set up the virtual environment and install tools -```bash -cd ~/work-gh/mrva/mrvacommander/client/qldbtools -pip install -e . -``` + cd ~/work-gh/mrva/mrvacommander/client/qldbtools/ + python3.11 -m venv venv + source venv/bin/activate + pip install --upgrade pip -Full installation + # From requirements.txt + pip install -r requirements.txt + # Or explicitly + pip install jupyterlab pandas ipython + pip install lckr-jupyterlab-variableinspector -```bash -pip install qldbtools -``` +- Run jupyterlab + + cd ~/work-gh/mrva/mrvacommander/client + source venv/bin/activate + jupyter lab & + + The variable inspector is a right-click on an open console or notebook. + + The `jupyter` command produces output including + + Jupyter Server 2.14.1 is running at: + http://127.0.0.1:8888/lab?token=4c91308819786fe00a33b76e60f3321840283486457516a1 + + Use this to connect multiple front ends + +- Local development + + ```bash + cd ~/work-gh/mrva/mrvacommander/client/qldbtools + pip install -e . + ``` + +- Full installation + + ```bash + pip install qldbtools + ``` ## Usage diff --git a/client/requirements.txt b/client/qldbtools/requirements.txt similarity index 100% rename from client/requirements.txt rename to client/qldbtools/requirements.txt