diff options
author | Calum Lind <calumlind@gmail.com> | 2018-10-08 12:21:00 +0100 |
---|---|---|
committer | Calum Lind <calumlind@gmail.com> | 2018-10-08 12:21:00 +0100 |
commit | 5743382c655811f08a51d6e14cf4f6afb21d3d6c (patch) | |
tree | a892363542174047c2b8b6b9ae2f383f9d22c167 /docs | |
parent | 39f37e6133ae0de0b85dc60a3805ef9fa3471d33 (diff) | |
download | deluge-5743382c655811f08a51d6e14cf4f6afb21d3d6c.tar.gz deluge-5743382c655811f08a51d6e14cf4f6afb21d3d6c.tar.bz2 deluge-5743382c655811f08a51d6e14cf4f6afb21d3d6c.zip |
Remove Pipfile and pipenv
For now using requirements files and tox to setup a dev env so to
prevent confusion or stagnation of Pipfile remove it and pipenv
documentation.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/pipenv.md | 65 |
1 files changed, 0 insertions, 65 deletions
diff --git a/docs/source/pipenv.md b/docs/source/pipenv.md deleted file mode 100644 index c401d53e4..000000000 --- a/docs/source/pipenv.md +++ /dev/null @@ -1,65 +0,0 @@ -# Using pipenv - -For a quick summary read: https://docs.pipenv.org/basics/ - -## Prerequisites - -- python-libtorrent -- pip -- pipenv - -## Install pipenv and packages - -Install Pipenv and upgrade pip: - - pip install -U pip pipenv - -On Ubuntu: - - sudo -H pip install -U pip pipenv - -In order to have access to system libtorrent we use `--site-packages` and -enable `PIP_IGNORE_INSTALLED`. Hopefully libtorrent will be available as a -pypi package at somepoint. - -See: https://docs.pipenv.org/advanced/#working-with-platform-provided-python-components - -Note you can `export PIP_IGNORE_INSTALLED=1` to save prefixing each time. It -has been included in commands below to denote requirement. - -### Users - - PIP_IGNORE_INSTALLED=1 pipenv --site-packages install - -### Developers - - PIP_IGNORE_INSTALLED=1 pipenv --site-packages install --dev - -### Test libtorrent installed - - pipenv run python -c 'import libtorrent as lt; print(lt.version)' - -### Bash shell completion - -To enable Pipenv shell completion for commands: - - eval "$(pipenv --completion)" - -## Running commands - -You can either enter the Pipenv virtualenv shell: - - pipenv shell --fancy - ./setup.py build - -Note: To check whether you are in a venv use `which python`. - -or prefix commands with the `pipenv run` option: - - pipenv run ./setup.py build - -## Developing Deluge - -This is the equivalent to `setup.py develop` but uses the pipenv environment: - - pipenv install --dev -e . |