X-Git-Url: http://www.git.cypherpunks.ru/?p=gocheese.git;a=blobdiff_plain;f=README;h=16122c99287e18a8db500621e234ba3fff8d01c7;hp=8d5ce9501d732f2ef85b0d1110075e1ebd027e63;hb=HEAD;hpb=9e662204b6bd8cafdd2bbfe7534573d828eaef2b diff --git a/README b/README index 8d5ce95..16122c9 100644 --- a/README +++ b/README @@ -1,59 +1,2 @@ GoCheese is Python private package repository and caching proxy. - -It serves two purposes: - -* hosting of private locally uploaded packages - (conforming to PEP-0503 (Simple Repository API)) -* proxying and caching of missing packages from upstream PyPI - -To use it, just configure your pip.conf: - - [install] - index-url = http://gocheese.host:8080/simple/ - -You can upload packages to it with twine: - - twine upload - --repository-url http://gocheese.host:8080/simple/ \ - --username spam \ - --password foo dist/tarball.tar.gz - -Root directory has the following hierarchy: - - root - +-- public-package - | +- public-package-0.1.tar.gz.sha256 - | +- public-package-0.2.tar.gz - | +- public-package-0.2.tar.gz.sha256 - +-- private-package - | +- .private - | +- private-package-0.1.tar.gz - | +- private-package-0.1.tar.gz.sha256 - |... - -Each directory is a package name. When you trie to list unexistent -directory contents (you are downloading package you have not seen -before), then GoCheese will download all its package versions with -checksums and write then in .sha256 files. So you know what versions are -available at the moment. When you asks for particular package, then its -tarball is really downloaded and verified against the checksum. For -example in the root directory above we have downloaded only -public-package-0.2. Private packages contain .private file, indicating -that it must not be asked in PyPI if required version is missing. - --refresh URL behaves the same way as -simple one, but is always -refreshes package versions from PyPI when listing it. You can use it to -forcefully update package version. - -Initially it was created as a fork of https://github.com/c4s4/cheeseshop, -but nearly all the code was rewritten. It has huge differences: - -* no TLS support -* no YAML configuration, just command-line arguments -* no package overwriting ability -* no MD5-hashed passwords -* atomic packages store on filesystem -* proxying and caching of missing packages -* SHA256-checksummed packages (both uploaded and proxied one) - -GoCheese is free software: see the file COPYING for copying conditions. +See doc/gocheese.info and INSTALL for more documentation.