Repository: google/dfindexeddb (language: python)

Issue:
Package for Pypi



Discussion / hints:
Updated package config per #6 

Fix patch:
diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml
index a43f397..d012f9a 100644
--- a/.github/workflows/pylint.yml
+++ b/.github/workflows/pylint.yml
@@ -19,7 +19,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        pip install python-snappy
         pip install pylint
     - name: Analysing the code with pylint
       run: |
diff --git a/.github/workflows/pytype.yml b/.github/workflows/pytype.yml
index 4e42d44..6c43de4 100644
--- a/.github/workflows/pytype.yml
+++ b/.github/workflows/pytype.yml
@@ -19,7 +19,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        pip install python-snappy
         pip install pytype
     - name: Analysing the code with pytype
       run: |
diff --git a/README.md b/README.md
index 3182bc0..95d54e6 100644
--- a/README.md
+++ b/README.md
@@ -7,14 +7,14 @@ It parses leveldb, IndexedDB and javascript structures from these files without
 requiring native libraries.
 
 The content of IndexedDB files is dependent on what a web application stores
-locally/offline using the web browser's 
-[IndexedDB API](https://www.w3.org/TR/IndexedDB/).  Examples of content might 
+locally/offline using the web browser's
+[IndexedDB API](https://www.w3.org/TR/IndexedDB/).  Examples of content might
 include:
 * text from a text/source-code editor application,
 * emails and contact information from an e-mail application,
 * images and metadata from a photo gallery application
 
-## Installation
+## Installation from source
 
 ### Linux
 
@@ -24,11 +24,33 @@ include:
     $ sudo apt install libsnappy-dev
 ```
 
-2. Create a virutal environemnt and install the package
+2. Clone or download the repository to your local machine.
+
+3. Create a virutal environemnt and install the package
 
 ```
     $ python3 -m venv .venv
     $ source .venv/bin/activate
-    $ pip install -r requirements.txt
-    $ python setup.py install
+    $ pip install .
+```
+
+## Tools
+
+This repository contains a number of scripts which demonstrate how one can use
+this library.  To run these tools, please install the `click` python package.
+
+* `tools/indexeddb_dump.py` - parses structures from an IndexedDB and prints
+them to standard output.
+  - Optionally, you can also install the `leveldb` python package if you
+  would prefer to use a native leveldb library instead of the leveldb parser in
+  this repository.
+* `tools/ldb_dump.py` - parses structures from a LevelDB .ldb file and prints
+them to standard output.
+* `tools/log_dump.py` - parses structures from a LevelDB .log file and prints
+them to standard output.
+
+
+
+```
+    $ pip install click leveldb
 ```
diff --git a/pyproject.toml b/pyproject.toml
index 4ca3324..3081919 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -21,8 +21,8 @@ classifiers = [
   'Programming Language :: Python',
 ]
 
-[tool.setuptools.packages.find]
-where = ["dfindexeddb/"]
+[tool.setuptools]
+packages = ["dfindexeddb", "dfindexeddb.indexeddb", "dfindexeddb.leveldb"]
 
 [project.urls]
 Homepage = "https://github.com/google/dfindexeddb"
diff --git a/requirements.txt b/requirements.txt
deleted file mode 100644
index bf15704..0000000
--- a/requirements.txt
+++ /dev/null
@@ -1,3 +0,0 @@
-click==8.1.3
-leveldb==0.201
-python-snappy==0.6.1
diff --git a/requirements_dev.txt b/requirements_dev.txt
new file mode 100644
index 0000000..d1a1f94
--- /dev/null
+++ b/requirements_dev.txt
@@ -0,0 +1,2 @@
+pylint
+pytype


Test patch:
diff --git a/.github/workflows/unittests.yml b/.github/workflows/unittests.yml
index 6835d4a..05fb9f9 100644
--- a/.github/workflows/unittests.yml
+++ b/.github/workflows/unittests.yml
@@ -19,8 +19,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        pip install python-snappy
         pip install .
     - name: Run unittests
       run: |
-        python -m unittest discover -s tests -p '*.py' -t .
\ No newline at end of file
+        python -m unittest discover -s tests -p '*.py' -t .
diff --git a/test_requirements.txt b/test_requirements.txt
deleted file mode 100644
index e69de29..0000000