aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md14
-rw-r--r--fuzzycat/main.py3
-rw-r--r--setup.py7
3 files changed, 20 insertions, 4 deletions
diff --git a/README.md b/README.md
index 41ef9d4..cf50bbe 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@ Fuzzy matching publications for [fatcat](https://fatcat.wiki).
* [fuzzycat](https://pypi.org/project/fuzzycat/)
+Note: This is currently work-in-progress.
+
## Motivation
Most of the results on sites like [Google
@@ -21,6 +23,18 @@ other document) to the existing records.
This repository contains both generic code for matching as well as fatcat
specific code using the fatcat openapi client.
+## Running and Deployment
+
+* The library code can be used via
+ [fuzzycat](https://pypi.org/project/fuzzycat/) project.
+* The command line tool depends on [Pipenv](https://pypi.org/project/pipenv/),
+ the workflow is to use a git checkout, then run `pipenv run python -m
+fuzzycat.main ...` or other executable modules.
+
+For the future, an independent [pex](https://github.com/pantsbuild/pex) or
+[shiv](https://github.com/linkedin/shiv) executable would be a convenient
+option.
+
## Approach
* Local code, with command line entry points for matching as well as adapter
diff --git a/fuzzycat/main.py b/fuzzycat/main.py
new file mode 100644
index 0000000..7dcc7ea
--- /dev/null
+++ b/fuzzycat/main.py
@@ -0,0 +1,3 @@
+
+def main():
+ print("fuzzycat")
diff --git a/setup.py b/setup.py
index dd1834c..cdf4502 100644
--- a/setup.py
+++ b/setup.py
@@ -20,12 +20,11 @@ with open("README.md", "r") as fh:
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
- python_requires=">=3.6",
+ python_requires=">=3.5",
zip_safe=False,
entry_points={"console_scripts": [
- "fuzzycat-cluster=fuzzycat.cluster:main",
- "fuzzycat-verify=fuzzycat.verify:main",
- ],},
+ "fuzzycat=fuzzycat.main:main"
+ ]},
install_requires=[
"elasticsearch>=7",
# "fatcat-openapi-client",