Merge pull request #11 from edsu/pyproject

Update to using pyproject.toml

.github/workflows/run-tests.yaml

@@ -17,8 +17,9 @@ jobs:
 
  - name: Install test requirements
  run: |
- pip install tox
+ pip install poetry
+ poetry install
 
  - name: Run tests
  run: |
- tox
+ poetry run pytest

.gitignore

@@ -2,4 +2,6 @@ build/
 dist/
 warcio_sqlite.egg-info/
 .idea/
-*.db
+*.db
+poetry.lock
+__pycache__

README.md

@@ -18,7 +18,7 @@ warcdb import archive.warcdb ./tests/google.warc ./tests/frontpages.warc.gz "htt
 
 warcdb enable-fts ./archive.warcdb response payload
 
-# Saarch for records that mention "stocks" in their response body
+# Search for records that mention "stocks" in their response body
 warcdb search ./archive.warcdb response "stocks" -c "WARC-Record-ID"
 ```
 As you can see you can use any mix of local/remote and raw/compressed archives.
@@ -107,6 +107,22 @@ where json_extract(h.value, '$.header') like '%Cookie%'
 SQL
 ```
 
+## Develop
+
+You can use poetry to install dependencies and run the tests:
+
+```
+$ git clone https://github.com/Florents-Tselai/WarcDB.git
+$ cd WarcDB
+$ poetry install
+$ poetry run pytest
+```
+
+Then when you are ready to publish to PyPI:
+
+```
+$ poetry publish --build
+```
 
 Resources on WARC
 ----------------

pyproject.toml

@@ -0,0 +1,37 @@
+[tool.poetry]
+name = "warcdb"
+version = "0.1.0"
+description = "WarcDB: Web crawl data as SQLite databases"
+authors = ["Florents Tselai <florents@tselai.com>"]
+readme = "README.md"
+license = "Apache License, Version 2.0"
+repository = "https://github.com/Florents-Tselai/warcdb"
+classifiers = [
+ "Intended Audience :: Developers",
+ "Intended Audience :: Science/Research",
+]
+
+[tool.poetry.scripts]
+warcdb = "warcdb:warcdb_cli"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+sqlite-utils = "^3.26" 
+warcio = "^1.7"
+click = "^8.1"
+more-itertools = "^10.1"
+tqdm = "^4.66"
+requests = "^2.31"
+
+[tool.poetry.group.test.dependencies]
+pytest = "^7.4"
+black = "^23.10"
+
+[tool.pytest.ini_options]
+testpaths = [
+ "tests"
+]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"