diff options
| author | Bryan Newbold <bnewbold@robocracy.org> | 2019-08-29 12:24:17 +0200 |
|---|---|---|
| committer | Bryan Newbold <bnewbold@robocracy.org> | 2019-08-29 12:24:17 +0200 |
| commit | 7a54cfcedaede4689759a87030416f763ce4e583 (patch) | |
| tree | 5649ef1bb5686d6ad9cf211fdb35051337e1f4b0 | |
| parent | 934a58b889d65720d69fc4824e386c602e047308 (diff) | |
| download | fatcat-7a54cfcedaede4689759a87030416f763ce4e583.tar.gz fatcat-7a54cfcedaede4689759a87030416f763ce4e583.zip | |
clarify python pipenv/pyenv dependencies
| -rw-r--r-- | python/README.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/python/README.md b/python/README.md index 49fbf6e2..783ed966 100644 --- a/python/README.md +++ b/python/README.md @@ -9,6 +9,17 @@ Most of this code is an "application" which is tightly interwoven and intended to be run from this directory, but the client library is distributed on pypi.org. +## Dependencies + +This project uses `pipenv` to manage dependencies, and requires Python 3.5. +You can can install `pipenv` with `pip` (or `pip3`). If you also install +`pyenv`, `pipenv` will automatically install Python 3.5 for you. You may want +to set the `PIPENV_VENV_IN_PROJECT` environment variable on your development +machine (see pipenv docs for details). + +NOTE: ensure you are using at least pipenv version `2018.11.26`. Earlier +versions had a bug which caused problems with our local path dependency. + ## API Client Library The auto-generated python client library for the fatcat API lives under @@ -22,15 +33,6 @@ locally): ## Web Interface -This project uses `pipenv` to manage dependencies, and assumes Python 3.5 -(which pipenv may install if you are running a different local version; see -notes in Pipfile). You can can install `pipenv` with `pip`. You may want to set -the `PIPENV_VENV_IN_PROJECT` environment variable on your development machine -(see pipenv docs for details). - -NOTE: ensure you are using at least pipenv version `2018.11.26`. Earlier -versions had a bug which caused problems with our local path dependency. - To just run the web interface (which will try to connect to a back-end API server on the same machine by default), use: |