Skip to content

Commit

Permalink
Add and fix some info to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HerManNav committed Sep 16, 2022
1 parent bbabb49 commit 43c3a1a
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -22,14 +22,16 @@ 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
```

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:

```
Expand All @@ -47,6 +49,7 @@ pypickup list numpy
## Development

In order to speed up development, we recommend an editable installation:

```
pip install --editable .
```

0 comments on commit 43c3a1a

Please sign in to comment.