doc/usage.texi

   1 @node Usage
   2 @unnumbered Usage
   3
   4 To use it for download purposes, just configure your @file{pip.conf}:
   5
   6 @example
   7 [install]
   8 index-url = http://gocheese.host:8080/simple/
   9 @end example
  10
  11 @option{-refresh} URL (@code{/simple/} by default) automatically
  12 refreshes metainformation (available versions and their checksums)
  13 from the upstream, when queried for package directory listing.
  14 @option{-norefresh} prevents upstream queries.
  15
  16 @option{-gpgupdate} is useful mainly for migrated for Pyshop migrated
  17 repositories. It forces GPG signature files downloading for all existing
  18 package files.
  19
  20 You can upload packages to it with @url{https://pypi.org/project/twine/, twine}:
  21
  22 @example
  23 twine upload
  24     --repository-url http://gocheese.host:8080/simple/ \
  25     --username spam \
  26     --password foo dist/tarball.tar.gz
  27 @end example
  28
  29 Or you can store it permanently in @file{.pypirc}:
  30
  31 @example
  32 [pypi]
  33 repository: https://gocheese.host/simple/
  34 username: spam
  35 password: foo
  36 @end example
  37
  38 If @command{twine} sends SHA256 checksum in the request, then uploaded
  39 file is checked against it.
  40
  41 Pay attention that you have to manually create corresponding private
  42 package directory! You are not allowed to upload anything explicitly
  43 flagged as internal package.
  44
  45 It is advisable to run GoCheese under some kind of
  46 @url{http://cr.yp.to/daemontools.html, daemontools}.