Clean up package info
This commit is contained in:
committed by
=Michael Hohn
parent
dcc32ea8ab
commit
3df1cac5ae
2
.gitignore
vendored
2
.gitignore
vendored
@@ -45,3 +45,5 @@ go.work.sum
|
|||||||
/qldbminio/qldb
|
/qldbminio/qldb
|
||||||
.ipynb_checkpoints/
|
.ipynb_checkpoints/
|
||||||
venv/
|
venv/
|
||||||
|
*.egg-info
|
||||||
|
__pycache__
|
||||||
|
|||||||
26
README.md
26
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
|
3. is session based to allow iterations on selection / narrowing
|
||||||
4. must be queryable. There is no need to reinvent sql / dataframes
|
4. must be queryable. There is no need to reinvent sql / dataframes
|
||||||
|
|
||||||
Python with dataframes is ideal for this.
|
Python with dataframes is ideal for this; the project is in `client/`.
|
||||||
|
|
||||||
- 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
|
|
||||||
|
|
||||||
## Reverse proxy
|
## Reverse proxy
|
||||||
For testing, replay flows using mitmweb. This is faster and simpler than using
|
For testing, replay flows using mitmweb. This is faster and simpler than using
|
||||||
|
|||||||
@@ -4,14 +4,42 @@ qldbtools is a Python package for working with CodeQL databases
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Local development
|
- Set up the virtual environment and install tools
|
||||||
|
|
||||||
|
cd ~/work-gh/mrva/mrvacommander/client/qldbtools/
|
||||||
|
python3.11 -m venv venv
|
||||||
|
source venv/bin/activate
|
||||||
|
pip install --upgrade pip
|
||||||
|
|
||||||
|
# From requirements.txt
|
||||||
|
pip install -r requirements.txt
|
||||||
|
# Or explicitly
|
||||||
|
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
|
||||||
|
|
||||||
|
- Local development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd ~/work-gh/mrva/mrvacommander/client/qldbtools
|
cd ~/work-gh/mrva/mrvacommander/client/qldbtools
|
||||||
pip install -e .
|
pip install -e .
|
||||||
```
|
```
|
||||||
|
|
||||||
Full installation
|
- Full installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install qldbtools
|
pip install qldbtools
|
||||||
|
|||||||
Reference in New Issue
Block a user