From 43c3a1a2147510fe6c9034ed2178f7fc4d488f17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Germ=C3=A1n=20Navarro?= Date: Fri, 16 Sep 2022 17:02:07 +0200 Subject: [PATCH] Add and fix some info to README.md --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 767b57a..a89aa72 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A tool to download packages from PyPI and save them locally, building a directory tree that fulfills [PEP 503](https://peps.python.org/pep-0503/). Properly configured, `pip` will install packages from there as if it was downloading them from the PyPI repository itself. -For example, the following commands will download all final versions (no `dev` versions), source distributions of `numpy` into the `.pypickup` folder, and then install the lates compatible version from there. +For example, the following commands will download all final versions (no `dev` and no `rc` versions), source distributions of `numpy` into the `.pypickup` folder, and then install the latest compatible version from there. ``` pypickup add -s -p ./.pypickup numpy pip install --index-url ./.pypickup numpy @@ -22,7 +22,7 @@ To add a package for the first time: pypickup add numpy ``` -This will create a folder in the default location (~/.pypickup/) in which all the stablished files (.whl and .zip) for the specified package will be downloaded. Besides, it will create the corresponding metadata files (index.html) to track that package. The next time you want to synchronize the same package against the PyPI remote repository, you should do: +This will create a folder in the default location (./.pypickup/) in which all the stablished files (.whl and .zip) for the specified package will be downloaded. Besides, it will create the corresponding metadata files (index.html) to track that package. The next time you want to synchronize the same package against the PyPI remote repository, you should do: ``` pypickup update numpy @@ -30,6 +30,8 @@ pypickup update numpy This will download the new packages available in the remote, in case there is any. It'll do nothing otherwise. It also updates the index.html of the indicated package with the new downloaded packages, as expected. +To redefine another default location we may set an environment variable PYPICKUP_INDEX_PATH. + 2 more commands are available to remove packages and to list the available ones already added: ``` @@ -47,6 +49,7 @@ pypickup list numpy ## Development In order to speed up development, we recommend an editable installation: + ``` pip install --editable . ``` \ No newline at end of file