From 3c8db9cbe48cdcfb94c6b170a89a2ceaec858f8c Mon Sep 17 00:00:00 2001 From: Michael Hohn Date: Wed, 10 Jul 2024 15:04:09 -0700 Subject: [PATCH] Put the DB code into a package --- client/qldbtools/README.md | 26 +++++++++++++++++++ client/qldbtools/qldbtools/__init__.py | 2 ++ .../qldbtools/utils.py} | 0 client/qldbtools/setup.py | 12 +++++++++ 4 files changed, 40 insertions(+) create mode 100644 client/qldbtools/README.md create mode 100644 client/qldbtools/qldbtools/__init__.py rename client/{db_load_fs.py => qldbtools/qldbtools/utils.py} (100%) create mode 100644 client/qldbtools/setup.py diff --git a/client/qldbtools/README.md b/client/qldbtools/README.md new file mode 100644 index 0000000..01fe2d9 --- /dev/null +++ b/client/qldbtools/README.md @@ -0,0 +1,26 @@ +# qldbtools + +qldbtools is a Python package for working with CodeQL databases + +## Installation + +Local development + +```bash +cd ~/work-gh/mrva/mrvacommander/client/qldbtools +pip install -e . +``` + +Full installation + +```bash +pip install qldbtools +``` + +## Usage + +```python +import qldbtools as ql +``` + + diff --git a/client/qldbtools/qldbtools/__init__.py b/client/qldbtools/qldbtools/__init__.py new file mode 100644 index 0000000..ac963d7 --- /dev/null +++ b/client/qldbtools/qldbtools/__init__.py @@ -0,0 +1,2 @@ +from . import utils + diff --git a/client/db_load_fs.py b/client/qldbtools/qldbtools/utils.py similarity index 100% rename from client/db_load_fs.py rename to client/qldbtools/qldbtools/utils.py diff --git a/client/qldbtools/setup.py b/client/qldbtools/setup.py new file mode 100644 index 0000000..bfbdb05 --- /dev/null +++ b/client/qldbtools/setup.py @@ -0,0 +1,12 @@ +from setuptools import setup, find_packages + +setup( + name='qldbtools', + version='0.1.0', + description='A Python package for working with CodeQL databases', + author='Michael Hohn', + author_email='hohn@github.com', + packages=find_packages(), + install_requires=[ + ], +)