Commit ab8a64f

bryfry <bryon@fryer.io>
2026-01-06 20:29:27
more init
1 parent 7fb78c0
Changed files (2)
.gitignore
@@ -1,2 +1,3 @@
 /src/
 /venv/
+/scratch/
CLAUDE.md
@@ -2,11 +2,15 @@
 
 `gowarcprox` is a rewrite of `internetarchive/warcprox` in golang heavily 
 relying on the features provided by `internetarchive/gowarc`. The rewritten
-software should emulate all of the observable features and 
+software should emulate all of the observable features and interfaces. 
+
+Exceptions:
+ - support only sqlite (omit all support for rethinkdb)
+ - python plugins (no plugin support)
 
 ## git
 
-- The source repos and venv directories (`src` and `venv`) should not be 
+- The source repos, venv and scratch directories (`src`, `scratch`, `venv`) should not be 
   commited to this repo
   - They are added to the `.gitignore` for this project
 - Planned implementations should utilize git commits and branches as 
@@ -38,6 +42,21 @@ All reccomendations and guidelines from this repo should be followed.
 A python virtual environment is provided at `./venv` and has the warxprox installed.
 - Use with `./venv/bin/warcprox` for testing functionality of the original repo.
 
+## scratch
+
+Use the `./scratch` folder for testing.  For example:
+
+```bash
+./venv/bin/warcprox --dir ./scratch/test_001 \
+    --certs-dir ./scratch/test_001 \
+    --stats-db-file  ./scratch/test_001/warcprox.sqlite \
+    --dedup-db-file  ./scratch/test_001/warcprox.sqlite \
+    --cacert ./scratch/test_001/ca.pem
+```
+
+
+Nothing from this directory should be stored or retained except while testing.
+
 ## golang: prefered libraries
 
 - https://github.com/spf13/cobra.git - for cli flags and argument parsing