diff options
| author | Martin Czygan <martin.czygan@gmail.com> | 2020-10-31 15:46:09 +0100 |
|---|---|---|
| committer | Martin Czygan <martin.czygan@gmail.com> | 2020-10-31 15:46:09 +0100 |
| commit | 248f4e6049ddce7dde327a532fb2a9b9c545e8ec (patch) | |
| tree | d743184d7abc45dfd4ccafc2aa0bd76d04b665c3 | |
| parent | fefc9d4b991e4c647463813547de0db2c067dbe7 (diff) | |
| download | fuzzycat-248f4e6049ddce7dde327a532fb2a9b9c545e8ec.tar.gz fuzzycat-248f4e6049ddce7dde327a532fb2a9b9c545e8ec.zip | |
update deploy notes
| -rw-r--r-- | README.md | 14 |
1 files changed, 8 insertions, 6 deletions
@@ -25,15 +25,17 @@ 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. +We defer more packaging polish until the code stabilizes a bit more. For now: + +``` +$ git clone git@github.com:miku/fuzzycat.git && cd fuzzycat +$ pipenv install --deploy +$ pipenv run python -m fuzzycat.main +``` For the future, an independent [pex](https://github.com/pantsbuild/pex) or [shiv](https://github.com/linkedin/shiv) executable would be a convenient -option. +option to allow execution from any directory. ## Approach |