summaryrefslogtreecommitdiffstats
path: root/python/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'python/README.md')
-rw-r--r--python/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/python/README.md b/python/README.md
new file mode 100644
index 00000000..dbf6aef7
--- /dev/null
+++ b/python/README.md
@@ -0,0 +1,27 @@
+
+ __ _ _
+ / _| __ _| |_ ___ __ _| |_
+ | |_ / _` | __/ __/ _` | __|
+ | _| (_| | || (_| (_| | |_
+ |_| \__,_|\__\___\__,_|\__|
+
+ ... catalog all the things!
+
+
+This is just a concept for now; see [rfc](./rfc).
+
+
+## Python Prototype
+
+Use `pipenv` (which you can install with `pip`).
+
+ pipenv run run.py --init-db
+ pipenv run run.py
+
+Run tests:
+
+ pipenv run pytest
+
+ # for coverage:
+ pipenv run pytest --cov --cov-report html
+