2011-07-29 03:14:09 +02:00
|
|
|
.. -*- mode: rst; coding: utf-8 -*-
|
|
|
|
|
2016-01-21 19:27:38 +01:00
|
|
|
.. image:: pypiserver_logo.png
|
|
|
|
:width: 300 px
|
|
|
|
:align: center
|
|
|
|
|
2011-07-29 03:14:09 +02:00
|
|
|
==============================================================================
|
|
|
|
pypiserver - minimal PyPI server for use with pip/easy_install
|
|
|
|
==============================================================================
|
2015-09-11 18:40:07 +02:00
|
|
|
|pypi-ver| |travis-status| |dependencies| |downloads-count| |python-ver| \
|
|
|
|
|proj-license|
|
2011-07-29 03:14:09 +02:00
|
|
|
|
2016-06-25 05:04:08 +02:00
|
|
|
:Version: 1.2.1.dev0
|
|
|
|
:Date: 2016-XX-XX
|
2015-12-21 23:05:03 +01:00
|
|
|
:Source: https://github.com/pypiserver/pypiserver
|
|
|
|
:PyPI: https://pypi.python.org/pypi/pypiserver
|
|
|
|
:Travis: https://travis-ci.org/pypiserver/pypiserver
|
2016-06-28 13:13:32 +02:00
|
|
|
:Maintainers: Kostis Anagnostopoulos <ankostis@gmail.com>,
|
|
|
|
Matthew Planchard <mplanchard@gmail.com>
|
2015-12-21 23:05:03 +01:00
|
|
|
:License: zlib/libpng + MIT
|
2011-07-31 23:42:37 +02:00
|
|
|
|
2016-01-21 19:27:38 +01:00
|
|
|
*pypiserver* is a minimal PyPI_ compatible server for *pip* or *easy_install*.
|
2016-06-17 21:44:50 +02:00
|
|
|
It is based on bottle_ and serves packages from regular directories.
|
|
|
|
Wheels, bdists, eggs and accompanying PGP-signatures can be uploaded
|
2016-06-28 13:13:32 +02:00
|
|
|
either with *pip*, *setuptools*, `twine`_, `pypi-uploader`_, or simply copied
|
|
|
|
with *scp*.
|
2011-07-31 23:42:37 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
|
2016-01-21 19:27:38 +01:00
|
|
|
.. contents:: Table of Contents
|
|
|
|
:backlinks: top
|
2011-07-29 03:14:09 +02:00
|
|
|
|
2015-03-08 18:37:34 +01:00
|
|
|
|
|
|
|
Quickstart: Installation and Usage
|
|
|
|
==================================
|
2016-06-23 21:17:13 +02:00
|
|
|
*pypiserver* ``> 1.2.x`` works with python ``2.7`` and ``3.3+`` or *pypy*.
|
2016-07-02 13:33:23 +02:00
|
|
|
Older python-versions may still work, but they are not tested.
|
2016-06-23 21:17:13 +02:00
|
|
|
For legacy python versions, use ``pypiserver-1.1.x`` series.
|
2011-07-31 23:42:37 +02:00
|
|
|
|
2016-07-02 13:46:09 +02:00
|
|
|
.. Tip::
|
|
|
|
The commands below work on a unix-like operating system with a posix shell.
|
|
|
|
The ``'~'`` character expands to user's home directory.
|
|
|
|
|
|
|
|
If you're using Windows, you'll have to use their "Windows counterparts".
|
|
|
|
The same is true for the rest of this documentation.
|
|
|
|
|
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
1. Install *pypiserver* with this command::
|
2011-07-29 03:14:09 +02:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
pip install pypiserver ## Or: pypiserver[passlib,watchdog]
|
|
|
|
mkdir ~/packages ## Copy packages into this directory.
|
2015-09-11 18:40:07 +02:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
See also `Alternative Installation methods`_.
|
2015-02-27 23:02:07 +01:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
2. Copy some packages into your ``~/packages`` folder and then
|
|
|
|
get your *pypiserver* up and running::
|
2016-01-21 19:27:38 +01:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
pypi-server -p 8080 ~/packages & ## Will listen to all IPs.
|
2011-07-29 03:14:09 +02:00
|
|
|
|
2016-07-02 13:46:09 +02:00
|
|
|
3. From the client computer, type this::
|
2016-07-02 13:33:23 +02:00
|
|
|
|
|
|
|
## Download and Install hosted packages.
|
|
|
|
pip install --extra-index-url http://localhost:8080/simple/ ...
|
|
|
|
## Search hosted packages
|
|
|
|
pip search --index http://localhost:8080/simple/ ...
|
|
|
|
|
|
|
|
See also `Client-side configurations`_ for avoiding tedious typing.
|
2014-01-05 01:32:34 +01:00
|
|
|
|
2016-07-02 13:46:09 +02:00
|
|
|
4. Enter ``pypi-server -h`` in the cmd-line to print a detailed usage message::
|
|
|
|
|
|
|
|
pypi-server [OPTIONS] [PACKAGES_DIRECTORY...]
|
|
|
|
start PyPI compatible package server serving packages from
|
|
|
|
PACKAGES_DIRECTORY. If PACKAGES_DIRECTORY is not given on the
|
|
|
|
command line, it uses the default ~/packages. pypiserver scans this
|
|
|
|
directory recursively for packages. It skips packages and
|
|
|
|
directories starting with a dot. Multiple package directories can be
|
|
|
|
specified.
|
|
|
|
|
|
|
|
pypi-server understands the following options:
|
|
|
|
|
|
|
|
-p, --port PORT
|
|
|
|
listen on port PORT (default: 8080)
|
|
|
|
|
|
|
|
-i, --interface INTERFACE
|
|
|
|
listen on interface INTERFACE (default: 0.0.0.0, any interface)
|
|
|
|
|
|
|
|
-a, --authenticate (UPDATE|download|list), ...
|
|
|
|
comma-separated list of (case-insensitive) actions to authenticate
|
|
|
|
Use '.' or '' for empty. Requires to have set the password (-P option).
|
|
|
|
For example to password-protect package downloads (in addition to uploads)
|
|
|
|
while leaving listings public, give:
|
|
|
|
-P foo/htpasswd.txt -a update,download
|
|
|
|
To drop all authentications, use:
|
|
|
|
-P . -a .
|
|
|
|
Note that when uploads are not protected, the `register` command
|
|
|
|
is not necessary, but `~/.pypirc` still need username and password fields,
|
|
|
|
even if bogus.
|
|
|
|
By default, only 'update' is password-protected.
|
|
|
|
|
|
|
|
-P, --passwords PASSWORD_FILE
|
|
|
|
use apache htpasswd file PASSWORD_FILE to set usernames & passwords when
|
|
|
|
authenticating certain actions (see -a option).
|
|
|
|
If you want to allow un-authorized access, set this option and -a
|
|
|
|
explicitly to empty (either '.' or'').
|
|
|
|
|
|
|
|
--disable-fallback
|
|
|
|
disable redirect to real PyPI index for packages not found in the
|
|
|
|
local index
|
|
|
|
|
|
|
|
--fallback-url FALLBACK_URL
|
|
|
|
for packages not found in the local index, this URL will be used to
|
|
|
|
redirect to (default: http://pypi.python.org/simple)
|
|
|
|
|
|
|
|
--server METHOD
|
|
|
|
use METHOD to run the server. Valid values include paste,
|
|
|
|
cherrypy, twisted, gunicorn, gevent, wsgiref, auto. The
|
|
|
|
default is to use "auto" which chooses one of paste, cherrypy,
|
|
|
|
twisted or wsgiref.
|
|
|
|
|
|
|
|
-r, --root PACKAGES_DIRECTORY
|
|
|
|
[deprecated] serve packages from PACKAGES_DIRECTORY
|
|
|
|
|
|
|
|
-o, --overwrite
|
|
|
|
allow overwriting existing package files
|
|
|
|
|
|
|
|
--hash-algo ALGO
|
|
|
|
any `hashlib` available algo used as fragments on package links.
|
|
|
|
Set one of (0, no, off, false) to disabled it. (default: md5)
|
|
|
|
|
|
|
|
--welcome HTML_FILE
|
|
|
|
uses the ASCII contents of HTML_FILE as welcome message response.
|
|
|
|
|
|
|
|
-v
|
|
|
|
enable INFO logging; repeat for more verbosity.
|
|
|
|
|
|
|
|
--log-conf <FILE>
|
|
|
|
read logging configuration from FILE.
|
|
|
|
By default, configuration is read from `log.conf` if found in server's dir.
|
|
|
|
|
|
|
|
--log-file <FILE>
|
|
|
|
write logging info into this FILE.
|
|
|
|
|
|
|
|
--log-frmt <FILE>
|
|
|
|
the logging format-string. (see `logging.LogRecord` class from standard python library)
|
|
|
|
[Default: %(asctime)s|%(name)s|%(levelname)s|%(thread)d|%(message)s]
|
|
|
|
|
|
|
|
--log-req-frmt FORMAT
|
|
|
|
a format-string selecting Http-Request properties to log; set to '%s' to see them all.
|
|
|
|
[Default: %(bottle.request)s]
|
|
|
|
|
|
|
|
--log-res-frmt FORMAT
|
|
|
|
a format-string selecting Http-Response properties to log; set to '%s' to see them all.
|
|
|
|
[Default: %(status)s]
|
|
|
|
|
|
|
|
--log-err-frmt FORMAT
|
|
|
|
a format-string selecting Http-Error properties to log; set to '%s' to see them all.
|
|
|
|
[Default: %(body)s: %(exception)s \n%(traceback)s]
|
|
|
|
|
|
|
|
pypi-server -h
|
|
|
|
pypi-server --help
|
|
|
|
show this help message
|
|
|
|
|
|
|
|
pypi-server --version
|
|
|
|
show pypi-server's version
|
|
|
|
|
|
|
|
pypi-server -U [OPTIONS] [PACKAGES_DIRECTORY...]
|
|
|
|
update packages in PACKAGES_DIRECTORY. This command searches
|
|
|
|
pypi.python.org for updates and shows a pip command line which
|
|
|
|
updates the package.
|
|
|
|
|
|
|
|
The following additional options can be specified with -U:
|
|
|
|
|
|
|
|
-x
|
|
|
|
execute the pip commands instead of only showing them
|
|
|
|
|
|
|
|
-d DOWNLOAD_DIRECTORY
|
|
|
|
download package updates to this directory. The default is to use
|
|
|
|
the directory which contains the latest version of the package to
|
|
|
|
be updated.
|
|
|
|
|
|
|
|
-u
|
|
|
|
allow updating to unstable version (alpha, beta, rc, dev versions)
|
|
|
|
|
|
|
|
Visit https://github.com/pypiserver/pypiserver for more information.
|
2015-09-11 18:40:07 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
|
2015-03-08 18:37:34 +01:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
Client-side Configurations
|
|
|
|
==========================
|
|
|
|
Always specifying the the pypi url on the command line is a bit
|
|
|
|
cumbersome. Since *pypiserver* redirects ``pip/easy_install`` to the
|
|
|
|
``pypi.python.org`` index if it doesn't have a requested package, it's a
|
|
|
|
good idea to configure them to always use your local pypi index.
|
|
|
|
|
|
|
|
Configuring *pip*
|
|
|
|
-----------------
|
|
|
|
For ``pip`` command this can be done by setting the environment variable
|
|
|
|
``PIP_EXTRA_INDEX_URL`` in your ``.bashr/.profile/.zshrc``::
|
|
|
|
|
|
|
|
export PIP_EXTRA_INDEX_URL=http://localhost:8080/simple/
|
|
|
|
|
|
|
|
or by adding the following lines to ``~/.pip/pip.conf``::
|
|
|
|
|
|
|
|
[global]
|
|
|
|
extra-index-url = http://localhost:8080/simple/
|
|
|
|
|
|
|
|
.. Note::
|
|
|
|
If you have installed *pypiserver* on a remote url without *https*
|
|
|
|
you wil receive an "untrusted" warning from *pip*, urging you to append
|
|
|
|
the ``--trusted-host`` option. You can also include this option permanently
|
|
|
|
in your configuration-files or environment variables.
|
|
|
|
|
|
|
|
|
|
|
|
Configuring *easy_install*
|
|
|
|
--------------------------
|
|
|
|
For ``easy_install`` command you may set the following configuration in
|
|
|
|
``~/.pydistutils.cfg``::
|
|
|
|
|
|
|
|
[easy_install]
|
|
|
|
index_url = http://localhost:8080/simple/
|
|
|
|
|
|
|
|
|
|
|
|
Uploading Packages Remotely
|
|
|
|
===========================
|
|
|
|
Instead of copying packages directly to the server's folder (i.e. with ``scp``),
|
|
|
|
you may use python tools for the task, e.g. ``python setup.py upload``.
|
|
|
|
In that case, *pypiserver* is responsible for authenticating the upload-requests.
|
|
|
|
|
|
|
|
|
|
|
|
.. Note::
|
|
|
|
We strongly advise to password-protected your uploads!
|
|
|
|
|
|
|
|
It is possible to disable authentication for uploads (e.g. in intranets).
|
|
|
|
To avoid lazy security decisions, read help for ``-P`` and ``-a`` options.
|
|
|
|
|
2015-03-08 18:37:34 +01:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
*Apache*-like authentication (``htpasswd``)
|
|
|
|
-------------------------------------------
|
2016-03-11 18:46:29 +01:00
|
|
|
#. First make sure you have the *passlib* module installed (note that
|
2016-06-24 19:56:09 +02:00
|
|
|
``passlib>=1.6`` is required), which is needed for parsing the Apache
|
|
|
|
*htpasswd* file specified by the ``-P``, ``--passwords`` option
|
2016-03-11 18:46:29 +01:00
|
|
|
(see next steps)::
|
2015-03-08 18:37:34 +01:00
|
|
|
|
|
|
|
pip install passlib
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
#. Create the Apache *htpasswd* file with at least one user/password pair
|
2015-03-08 18:37:34 +01:00
|
|
|
with this command (you'll be prompted for a password)::
|
|
|
|
|
2016-01-17 23:26:15 +01:00
|
|
|
htpasswd -sc htpasswd.txt <some_username>
|
2015-03-08 18:37:34 +01:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
.. Tip:: Read this SO question for running `htpasswd` cmd
|
|
|
|
under *Windows*:
|
2015-09-11 18:40:07 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
http://serverfault.com/questions/152950/how-to-create-and-edit-htaccess-and-htpasswd-locally-on-my-computer-and-then-u
|
2015-09-17 01:39:13 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
or if you have bogus passwords that you don't care because they are for
|
|
|
|
an internal service (which is still "bad", from a security prespective...)
|
|
|
|
you may use this public service:
|
2015-09-17 01:39:13 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
http://www.htaccesstools.com/htpasswd-generator/
|
2015-09-11 18:40:07 +02:00
|
|
|
|
2016-06-24 19:56:09 +02:00
|
|
|
.. Tip:: When accessing pypiserver via the api, alternate authentication
|
|
|
|
methods are available via the ``auther`` config flag. Any callable
|
|
|
|
returning a boolean can be passed through to the pypiserver config in
|
2016-06-24 22:12:29 +02:00
|
|
|
order to provide custom authentication. For example, to configure
|
|
|
|
pypiserver to authenticate using the `python-pam`_::
|
2015-03-08 18:37:34 +01:00
|
|
|
|
2016-06-24 19:56:09 +02:00
|
|
|
import pam
|
|
|
|
pypiserver.default_config(auther=pam.authenticate)
|
2016-06-22 16:56:15 +02:00
|
|
|
|
2016-06-28 11:18:39 +02:00
|
|
|
Please see `Using Ad-hoc authentication providers`_ for more information.
|
2016-06-24 22:12:29 +02:00
|
|
|
|
2016-06-24 19:56:09 +02:00
|
|
|
#. You need to restart the server with the ``-P`` option only once
|
|
|
|
(but user/password pairs can later be added or updated on the fly)::
|
2016-06-22 16:56:15 +02:00
|
|
|
|
2016-06-24 19:56:09 +02:00
|
|
|
./pypi-server -p 8080 -P htpasswd.txt ~/packages &
|
2016-06-22 15:49:06 +02:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
Upload with *setuptools*
|
|
|
|
------------------------
|
2016-06-24 19:56:09 +02:00
|
|
|
#. On client-side, edit or create a ``~/.pypirc`` file with a similar content::
|
2015-03-08 18:37:34 +01:00
|
|
|
|
|
|
|
[distutils]
|
|
|
|
index-servers =
|
|
|
|
pypi
|
2015-09-17 13:52:00 +02:00
|
|
|
local
|
2015-09-11 18:40:07 +02:00
|
|
|
|
2015-03-08 18:37:34 +01:00
|
|
|
[pypi]
|
|
|
|
username:<your_pypi_username>
|
|
|
|
password:<your_pypi_passwd>
|
2015-09-11 18:40:07 +02:00
|
|
|
|
2015-09-17 13:52:00 +02:00
|
|
|
[local]
|
2015-03-08 18:37:34 +01:00
|
|
|
repository: http://localhost:8080
|
|
|
|
username: <some_username>
|
|
|
|
password: <some_passwd>
|
|
|
|
|
2015-09-11 18:40:07 +02:00
|
|
|
#. Then from within the directory of the python-project you wish to upload,
|
2015-03-08 18:37:34 +01:00
|
|
|
issue this command::
|
|
|
|
|
2015-09-17 13:52:00 +02:00
|
|
|
python setup.py sdist upload -r local
|
|
|
|
|
2015-03-08 18:37:34 +01:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
Upload with `twine`_
|
|
|
|
--------------------
|
|
|
|
To avoid storing you passwords on disk, in clear text, you may either:
|
2016-01-19 20:22:42 +01:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
- use the ``register`` *setuptools*'s command with the ``-r`` option,
|
|
|
|
like that::
|
2016-01-19 20:22:42 +01:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
python setup.py sdist register -r local upload -r local
|
2016-01-19 20:22:42 +01:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
- use `twine`_ library, which
|
|
|
|
breaks the procedure in two steps. In addition, it supports signing
|
|
|
|
your files with PGP-Signatures and uploading the generated `.asc` files
|
|
|
|
to *pypiserver*::
|
2016-06-23 05:03:40 +02:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
twine upload -r local --sign -identity user_name ./foo-1.zip
|
2016-06-23 05:03:40 +02:00
|
|
|
|
2015-03-08 18:37:34 +01:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
Upload with `pypi-uploader`_
|
|
|
|
----------------------------
|
|
|
|
You can also upload packages using `pypi-uploader`_, which
|
|
|
|
obviates the need to download packages locally prior to uploading them to
|
|
|
|
pypiserver. You can install it with ``pip install pypi-uploader``, and
|
|
|
|
assuming you have a ``pypi_local`` source set up in your ``~/.pypirc``,
|
|
|
|
use it like this::
|
2015-03-08 18:37:34 +01:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
pypiupload packages mock==1.0.1 requests==2.2.1 -i pypi_local
|
|
|
|
pypiupload requirements requirements.txt -i pypi_local
|
2014-01-05 01:32:34 +01:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
|
2015-09-11 18:40:07 +02:00
|
|
|
Alternative Installation methods
|
2015-03-08 18:37:34 +01:00
|
|
|
================================
|
2015-09-11 18:40:07 +02:00
|
|
|
When trying the methods below, first use the following command to check whether
|
2015-03-08 18:37:34 +01:00
|
|
|
previous versions of *pypiserver* already exist, and (optionally) uninstall them::
|
|
|
|
|
|
|
|
## VERSION-CHECK: Fails if not installed.
|
|
|
|
pypi-server --version
|
2015-09-11 18:40:07 +02:00
|
|
|
|
|
|
|
## UNINSTALL: Invoke again untill it fails.
|
2015-03-08 18:37:34 +01:00
|
|
|
pip uninstall pypiserver
|
2015-09-11 18:40:07 +02:00
|
|
|
|
2015-03-08 18:37:34 +01:00
|
|
|
|
|
|
|
Installing the very latest version
|
|
|
|
----------------------------------
|
2015-09-11 18:40:07 +02:00
|
|
|
In case the latest version in *pypi* is a pre-release, you have to use
|
2015-03-08 18:37:34 +01:00
|
|
|
*pip*'s `--pre` option. And to update an existing installation combine it
|
|
|
|
with `--ignore-installed`::
|
|
|
|
|
|
|
|
pip install pypiserver --pre -I
|
2015-09-11 18:40:07 +02:00
|
|
|
|
2015-03-08 18:37:34 +01:00
|
|
|
You can even install the latest *pypiserver* directly from *github* with the
|
2016-07-02 13:46:09 +02:00
|
|
|
following command, assuming you have *git* installed on your ``PATH``::
|
2015-03-08 18:37:34 +01:00
|
|
|
|
|
|
|
pip install git+git://github.com/pypiserver/pypiserver.git
|
|
|
|
|
|
|
|
|
|
|
|
Installing it as standalone script
|
|
|
|
----------------------------------
|
2015-02-27 23:02:07 +01:00
|
|
|
The git repository contains a ``pypi-server-standalone.py`` script,
|
2015-03-08 18:37:34 +01:00
|
|
|
which is a single python file that can be executed without any other
|
2011-08-01 23:09:42 +02:00
|
|
|
dependencies.
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
Run the following commands to download the script with ``wget``::
|
2011-08-01 23:09:42 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
wget https://raw.github.com/pypiserver/pypiserver/standalone/pypi-server-standalone.py
|
2011-08-01 23:09:42 +02:00
|
|
|
chmod +x pypi-server-standalone.py
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
or with ``curl``::
|
2011-08-01 23:09:42 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
curl -O https://raw.github.com/pypiserver/pypiserver/standalone/pypi-server-standalone.py
|
2011-08-01 23:09:42 +02:00
|
|
|
chmod +x pypi-server-standalone.py
|
|
|
|
|
2015-03-08 18:37:34 +01:00
|
|
|
You can then start-up the server with::
|
2011-08-01 23:09:42 +02:00
|
|
|
|
|
|
|
./pypi-server-standalone.py
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
Feel free to rename the script and move it into your ``$PATH``.
|
2011-08-01 23:09:42 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
Running on *heroku/dotcloud*
|
|
|
|
----------------------------
|
2012-10-05 00:22:58 +02:00
|
|
|
https://github.com/dexterous/pypiserver-on-the-cloud contains
|
2016-06-23 21:17:13 +02:00
|
|
|
instructions on how to run *pypiserver* on one of the supported cloud
|
2012-10-05 00:22:58 +02:00
|
|
|
service providers.
|
2011-07-29 03:14:09 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
|
2015-03-08 18:37:34 +01:00
|
|
|
|
2016-07-02 13:46:09 +02:00
|
|
|
Recipes
|
|
|
|
=======
|
2011-11-19 21:17:35 +01:00
|
|
|
|
|
|
|
Managing the package directory
|
2015-03-08 18:37:34 +01:00
|
|
|
------------------------------
|
2016-06-23 21:17:13 +02:00
|
|
|
The ``pypi-server`` command has the ``-U`` option that searches for updates of
|
2011-11-19 21:17:35 +01:00
|
|
|
available packages. It scans the package directory for available
|
|
|
|
packages and searches on pypi.python.org for updates. Without further
|
2015-02-27 23:02:07 +01:00
|
|
|
options ``pypi-server -U`` will just print a list of commands which must
|
2011-11-19 21:17:35 +01:00
|
|
|
be run in order to get the latest version of each package. Output
|
|
|
|
looks like::
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
$ ./pypi-server -U
|
|
|
|
checking 106 packages for newer version
|
2011-11-19 21:17:35 +01:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
.........u.e...........e..u.............
|
|
|
|
.....e..............................e...
|
|
|
|
..........................
|
2011-11-19 21:17:35 +01:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
no releases found on pypi for PyXML, Pymacs, mercurial, setuptools
|
2011-11-19 21:17:35 +01:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
# update raven from 1.4.3 to 1.4.4
|
|
|
|
pip -q install --no-deps --extra-index-url http://pypi.python.org/simple -d /home/ralf/packages/mirror raven==1.4.4
|
2011-11-19 21:17:35 +01:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
# update greenlet from 0.3.3 to 0.3.4
|
|
|
|
pip -q install --no-deps --extra-index-url http://pypi.python.org/simple -d /home/ralf/packages/mirror greenlet==0.3.4
|
2011-11-19 21:17:35 +01:00
|
|
|
|
|
|
|
It first prints for each package a single character after checking the
|
2016-06-23 21:17:13 +02:00
|
|
|
available versions on pypi. A dot(`.`) means the package is up-to-date, ``'u'``
|
|
|
|
means the package can be updated and ``'e'`` means the list of releases on
|
2015-02-27 23:02:07 +01:00
|
|
|
pypi is empty. After that it shows a *pip* command line which can be used
|
2011-11-19 21:17:35 +01:00
|
|
|
to update a one package. Either copy and paste that or run
|
2015-02-27 23:02:07 +01:00
|
|
|
``pypi-server -Ux`` in order to really execute those commands. You need
|
|
|
|
to have *pip* installed for that to work however.
|
2011-11-19 21:17:35 +01:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
Specifying an additional ``-u`` option will also allow alpha, beta and
|
2011-11-19 21:17:35 +01:00
|
|
|
release candidates to be downloaded. Without this option these
|
|
|
|
releases won't be considered.
|
2011-08-09 23:28:14 +02:00
|
|
|
|
2016-01-17 23:26:15 +01:00
|
|
|
|
2016-01-04 23:06:49 +01:00
|
|
|
Serving thousands of packages
|
|
|
|
-----------------------------
|
|
|
|
|
2016-01-17 23:26:15 +01:00
|
|
|
By default, *pypiserver* scans the entire packages directory each time an
|
2016-01-04 23:06:49 +01:00
|
|
|
incoming HTTP request occurs. This isn't a problem for a small number of
|
2016-07-02 13:33:23 +02:00
|
|
|
packages, but causes noticeable slow-downs when serving thousands of packages.
|
2016-01-04 23:06:49 +01:00
|
|
|
|
|
|
|
If you run into this problem, significant speedups can be gained by enabling
|
|
|
|
pypiserver's directory caching functionality. The only requirement is to
|
2016-07-02 13:33:23 +02:00
|
|
|
install the ``watchdog`` package, or it can be installed during ``pypiserver``
|
|
|
|
installation, by specifying the ``cache`` extras option::
|
2016-01-04 23:06:49 +01:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
pip install pypiserver[cache]
|
2016-01-04 23:06:49 +01:00
|
|
|
|
2016-01-20 21:18:22 +01:00
|
|
|
If you are using a static webserver such as *Apache* or *nginx* as
|
|
|
|
a reverse-proxy for pypiserver, additional speedup can be gained by
|
2016-01-19 20:48:01 +01:00
|
|
|
directly serving the packages directory:
|
|
|
|
|
2016-01-20 21:18:22 +01:00
|
|
|
For instance, in *nginx* you may adding the following config to serve
|
2016-01-19 20:48:01 +01:00
|
|
|
packages-directly directly (take care not to expose "sensitive" files)::
|
|
|
|
|
|
|
|
location /packages/ {
|
|
|
|
root /path/to/packages/parentdir;
|
|
|
|
}
|
2016-01-17 23:26:15 +01:00
|
|
|
|
2016-03-15 21:56:01 +01:00
|
|
|
If you have packages that are very large, you may find it helpful to
|
2016-06-23 21:17:13 +02:00
|
|
|
disable hashing of files (set ``--hash-algo=off``, or ``hash_algo=None`` when
|
2016-03-15 21:56:01 +01:00
|
|
|
using wsgi).
|
2011-08-01 01:58:04 +02:00
|
|
|
|
2016-06-23 04:41:52 +02:00
|
|
|
|
|
|
|
Managing Automated Startup
|
|
|
|
--------------------------
|
|
|
|
There are a variety of options for handling the automated starting of
|
2016-06-23 21:17:13 +02:00
|
|
|
pypiserver upon system startup. Two of the most common are *systemd* and
|
|
|
|
*supervisor*.
|
2016-06-23 04:41:52 +02:00
|
|
|
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
Running as a *systemd* service
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
*systemd* is installed by default on most modern Linux systems and as such,
|
|
|
|
it is an excellent option for managing the pypiserver process. An example
|
|
|
|
config file for ``systemd`` can be seen below::
|
2016-06-23 04:41:52 +02:00
|
|
|
|
|
|
|
[Unit]
|
2016-06-23 21:17:13 +02:00
|
|
|
Description=A minimal PyPI server for use with pip/easy_install.
|
2016-06-23 04:41:52 +02:00
|
|
|
After=network.target
|
|
|
|
|
|
|
|
[Service]
|
|
|
|
Type=simple
|
|
|
|
# systemd requires absolute path here too.
|
2016-06-23 21:17:13 +02:00
|
|
|
PIDFile=/var/run/pypiserver.pid
|
2016-06-23 04:41:52 +02:00
|
|
|
User=www-data
|
|
|
|
Group=www-data
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
ExecStart=/usr/local/bin/pypi-server -p 8080 -a update,download --log-file /var/log/pypiserver.log --P /etc/nginx/.htpasswd /var/www/pypi
|
2016-06-23 04:41:52 +02:00
|
|
|
ExecStop=/bin/kill -TERM $MAINPID
|
|
|
|
ExecReload=/bin/kill -HUP $MAINPID
|
|
|
|
Restart=always
|
|
|
|
|
|
|
|
WorkingDirectory=/var/www/pypi
|
|
|
|
|
|
|
|
TimeoutStartSec=3
|
|
|
|
RestartSec=5
|
|
|
|
|
|
|
|
[Install]
|
|
|
|
WantedBy=multi-user.target
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
Adjusting the paths and adding this file as ``pypiserver.service`` into your
|
2016-06-23 04:44:46 +02:00
|
|
|
``systemd/system`` directory will allow management of the pypiserver process with
|
2016-06-23 21:17:13 +02:00
|
|
|
``systemctl``, e.g. ``systemctl start pypiserver``.
|
|
|
|
|
|
|
|
More useful information about *systemd* can be found at
|
|
|
|
https://www.digitalocean.com/community/tutorials/how-to-use-systemctl-to-manage-systemd-services-and-units
|
2016-06-23 04:41:52 +02:00
|
|
|
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
Launching through *supervisor*
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
`supervisor <http://supervisord.org/>`_ has the benefit of being a pure python
|
|
|
|
package and as such, it provides excellent cross-platform support for process
|
|
|
|
management. An example configuration file for ``supervisor`` is given below::
|
2016-06-23 04:41:52 +02:00
|
|
|
|
|
|
|
[program:pypi]
|
|
|
|
command=/home/pypi/pypi-venv/bin/pypi-server -p 7001 -P /home/pypi/.htaccess /home/pypi/packages
|
|
|
|
directory=/home/pypi
|
|
|
|
user=pypi
|
|
|
|
autostart=true
|
|
|
|
autorestart=true
|
2016-06-23 21:17:13 +02:00
|
|
|
stderr_logfile=/var/log/pypiserver.err.log
|
|
|
|
stdout_logfile=/var/log/pypiserver.out.log
|
2016-06-23 04:41:52 +02:00
|
|
|
|
2016-06-23 04:44:46 +02:00
|
|
|
From there, the process can be managed via ``supervisord`` using ``supervisorctl``.
|
2016-06-23 04:41:52 +02:00
|
|
|
|
|
|
|
|
2016-06-25 04:02:59 +02:00
|
|
|
Using a different WSGI-server
|
2015-03-08 18:37:34 +01:00
|
|
|
-----------------------------
|
2016-06-25 04:02:59 +02:00
|
|
|
- The *bottle* web-server which supports many WSGI-servers, among others,
|
|
|
|
*paste*, *cherrypy*, *twisted* and *wsgiref* (part of python); you select
|
|
|
|
them using the ``--server`` flag.
|
2012-03-26 02:22:41 +02:00
|
|
|
|
2016-06-25 04:02:59 +02:00
|
|
|
- You may view all supported WSGI servers using the following interactive code::
|
2015-02-27 23:02:07 +01:00
|
|
|
|
2016-06-25 04:02:59 +02:00
|
|
|
>>> from pypiserver import bottle
|
|
|
|
>>> list(bottle.server_names.keys())
|
|
|
|
['cgi', 'gunicorn', 'cherrypy', 'eventlet', 'tornado', 'geventSocketIO',
|
|
|
|
'rocket', 'diesel', 'twisted', 'wsgiref', 'fapws3', 'bjoern', 'gevent',
|
|
|
|
'meinheld', 'auto', 'aiohttp', 'flup', 'gae', 'paste', 'waitress']
|
2015-02-27 23:02:07 +01:00
|
|
|
|
2016-06-25 04:02:59 +02:00
|
|
|
- If none of the above servers matches your needs, invoke just the
|
|
|
|
``pypiserver:app()`` method which returns the internal WSGI-app WITHOUT
|
|
|
|
starting-up a server - you may then send it to any WSGI-server you like.
|
2016-07-02 13:46:09 +02:00
|
|
|
Read also the `Utilizing the API`_ section.
|
2012-03-26 02:22:41 +02:00
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
- Some examples are given below - you may find more details in `bottle's
|
|
|
|
documentation <http://bottlepy.org/docs/dev/deployment.html#switching-the-server-backend>`_.
|
2012-03-26 02:22:41 +02:00
|
|
|
|
|
|
|
gunicorn
|
2015-03-08 18:37:34 +01:00
|
|
|
~~~~~~~~
|
2012-03-26 02:22:41 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
The following command uses *gunicorn* to start *pypiserver*::
|
2012-03-26 02:22:41 +02:00
|
|
|
|
2016-03-10 15:11:44 +01:00
|
|
|
gunicorn -w4 'pypiserver:app(root="/home/ralf/packages")'
|
2012-03-26 02:22:41 +02:00
|
|
|
|
2013-01-28 00:45:01 +01:00
|
|
|
or when using multiple roots::
|
|
|
|
|
2016-03-10 15:11:44 +01:00
|
|
|
gunicorn -w4 'pypiserver:app(root=["/home/ralf/packages", "/home/ralf/experimental"])'
|
2013-01-28 00:45:01 +01:00
|
|
|
|
|
|
|
|
2012-03-26 02:22:41 +02:00
|
|
|
apache/mod_wsgi
|
2015-03-08 18:37:34 +01:00
|
|
|
~~~~~~~~~~~~~~~
|
2016-07-02 13:46:09 +02:00
|
|
|
In case you're using *apache2* with *mod_wsgi*, you may adapt the following
|
|
|
|
Apache-configuration (contributed by Thomas Waldmann)::
|
|
|
|
|
|
|
|
## Apache virtualhost configuration for mod_wsgi daemon mode.
|
|
|
|
Alias /robots.txt /srv/yoursite/htdocs/robots.txt
|
|
|
|
WSGIPassAuthorization On
|
|
|
|
WSGIScriptAlias / /srv/yoursite/cfg/pypiserver.wsgi
|
|
|
|
WSGIDaemonProcess pypisrv user=pypisrv group=pypisrv processes=1 threads=5 maximum-requests=500 umask=0007 display-name=wsgi-pypisrv inactivity-timeout=300
|
|
|
|
WSGIProcessGroup pypisrv
|
2012-03-26 02:22:41 +02:00
|
|
|
|
2016-07-02 13:46:09 +02:00
|
|
|
And create a ``/srv/yoursite/cfg/pypiserver.wsgi`` file like this::
|
2012-03-26 02:22:41 +02:00
|
|
|
|
2016-07-02 13:46:09 +02:00
|
|
|
import pypiserver
|
|
|
|
|
|
|
|
conf = pypiserver.default_config(
|
|
|
|
root = "/srv/yoursite/packages",
|
|
|
|
password_file = "/srv/yoursite/htpasswd")
|
|
|
|
application = pypiserver.app(**conf)
|
2012-03-26 02:22:41 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
|
2012-04-08 00:29:14 +02:00
|
|
|
paste/pastedeploy
|
2015-03-08 18:37:34 +01:00
|
|
|
~~~~~~~~~~~~~~~~~
|
2016-06-23 21:17:13 +02:00
|
|
|
`paste <http://pythonpaste.org/>`_ allows to run multiple WSGI applications
|
|
|
|
under different URL paths. Therefore it's possible to serve different set
|
|
|
|
of packages on different paths.
|
2012-04-08 00:29:14 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
The following example ``paste.ini`` could be used to serve stable and
|
2012-04-08 00:29:14 +02:00
|
|
|
unstable packages on different paths::
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
[composite:main]
|
|
|
|
use = egg:Paste#urlmap
|
|
|
|
/unstable/ = unstable
|
|
|
|
/ = stable
|
2012-04-08 00:29:14 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
[app:stable]
|
|
|
|
use = egg:pypiserver#main
|
|
|
|
root = ~/stable-packages
|
2012-04-08 00:29:14 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
[app:unstable]
|
|
|
|
use = egg:pypiserver#main
|
|
|
|
root = ~/stable-packages
|
|
|
|
~/unstable-packages
|
2012-04-08 00:29:14 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
[server:main]
|
|
|
|
use = egg:gunicorn#main
|
|
|
|
host = 0.0.0.0
|
|
|
|
port = 9000
|
|
|
|
workers = 5
|
|
|
|
accesslog = -
|
2012-04-08 00:29:14 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
.. Note::
|
2016-06-23 21:17:13 +02:00
|
|
|
You need to install some more dependencies for this to work, like::
|
2012-04-08 00:29:14 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
pip install paste pastedeploy gunicorn pypiserver
|
2012-04-08 00:29:14 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
The server can then start with::
|
2012-04-08 00:29:14 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
gunicorn_paster paste.ini
|
2012-04-08 00:29:14 +02:00
|
|
|
|
2016-07-02 13:46:09 +02:00
|
|
|
|
|
|
|
Utilizing the API
|
|
|
|
-----------------
|
|
|
|
In order to enable ad-hoc authentication-providers or to use WSGI-servers
|
|
|
|
not supported by *bottle* out-of-the-box, you needed to launch *pypiserver*
|
|
|
|
via its API.
|
|
|
|
|
|
|
|
- The main entry-point for configuring *pypiserver* is the `pypiserver:app()
|
|
|
|
<https://github.com/pypiserver/pypiserver/blob/master/pypiserver/__init__.py#L116>`_
|
|
|
|
function. This function returns the internal WSGI-app that you my then
|
|
|
|
send to any WSGI-server you like.
|
|
|
|
|
|
|
|
- To get all ``pypiserver:app()`` keywords and their explanations, read the
|
|
|
|
function `pypiserver:default_config()
|
|
|
|
<https://github.com/pypiserver/pypiserver/blob/master/pypiserver/__init__.py#L35>`_.
|
|
|
|
|
|
|
|
- Finally, to fire-up a WSGI-server with the configured app, invoke
|
|
|
|
the ``bottle:run(app, host, port, server)`` function.
|
|
|
|
Note that *pypiserver* ships with it's own copy of *bottle*; to use it,
|
|
|
|
import it like that: ``from pypiserver import bottle``
|
|
|
|
|
2016-07-02 13:33:23 +02:00
|
|
|
Using ad-hoc authentication providers
|
2016-07-02 13:46:09 +02:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-06-25 04:02:59 +02:00
|
|
|
The ``auther`` keyword of ``pypiserver:app()`` function maybe set only using
|
|
|
|
the API. This can be any callable that returns a boolean when passed
|
|
|
|
the *username* and the *password* for a given request.
|
|
|
|
|
|
|
|
For example, to authenticate users based on the ``/etc/passwd`` file under Unix,
|
|
|
|
you may delegate such decisions to the `python-pam`_ library by following
|
|
|
|
these steps:
|
|
|
|
|
|
|
|
1. Ensure ``python-pam`` module is installed::
|
|
|
|
|
|
|
|
pip install python-pam
|
|
|
|
|
|
|
|
2. Create a python-script along these lines::
|
|
|
|
|
|
|
|
$ cat > pypiserver-start.py
|
|
|
|
import pypiserver
|
|
|
|
from pypiserver import bottle
|
|
|
|
import pam
|
|
|
|
pypiserver.app(root='./packages', auther=pam.authenticate)
|
|
|
|
bottle.run(app=app, host='0.0.0.0', port=80, server='auto')
|
|
|
|
|
|
|
|
[Ctrl+ D]
|
|
|
|
|
|
|
|
3. Invoke the python-script to start-up *pypiserver*::
|
|
|
|
|
|
|
|
$ python pypiserver-start.py
|
|
|
|
|
|
|
|
|
|
|
|
.. Note::
|
|
|
|
The `python-pam`_ module, requires *read* access to ``/etc/shadow`` file;
|
|
|
|
you may add the user under which *pypiserver* runs into the *shadow*
|
|
|
|
group, with a command like this: ``sudo usermod -a -G shadow pypy-user``.
|
|
|
|
|
2012-04-08 00:29:14 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
Sources
|
|
|
|
=======
|
2016-06-23 21:17:13 +02:00
|
|
|
To create a copy of the repository, use::
|
2011-08-01 23:09:42 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
git clone https://github.com/pypiserver/pypiserver.git
|
|
|
|
cd pypiserver
|
2011-08-01 23:09:42 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
To receive any later changes, in the above folder use::
|
2015-03-08 18:37:34 +01:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
git pull
|
2011-08-01 23:09:42 +02:00
|
|
|
|
2011-07-29 03:14:09 +02:00
|
|
|
|
2016-01-19 20:22:42 +01:00
|
|
|
Known Limitations
|
|
|
|
=================
|
2015-02-27 23:02:07 +01:00
|
|
|
*pypiserver* does not implement the full API as seen on PyPI_. It
|
2015-03-08 18:37:34 +01:00
|
|
|
implements just enough to make ``easy_install`` and ``pip install`` to work.
|
2011-07-31 23:42:37 +02:00
|
|
|
|
|
|
|
The following limitations are known:
|
|
|
|
|
2015-12-21 11:49:14 +01:00
|
|
|
- Command ``pypi -U`` that compares uploaded packages with *pypi* to see if
|
2016-06-23 21:17:13 +02:00
|
|
|
they are outdated, does not respect a http-proxy environment variable
|
2015-09-12 19:20:53 +02:00
|
|
|
(see https://github.com/pypiserver/pypiserver/issues/19).
|
2015-02-27 23:02:07 +01:00
|
|
|
- It accepts documentation uploads but does not save them to
|
|
|
|
disk (see https://github.com/pypiserver/pypiserver/issues/47 for a
|
2014-03-05 22:53:09 +01:00
|
|
|
discussion)
|
2016-01-19 20:22:42 +01:00
|
|
|
- It does not handle misspelled packages as *pypi-repo* does,
|
2016-06-23 21:17:13 +02:00
|
|
|
therefore it is suggested to use it with ``--extra-index-url`` instead
|
|
|
|
of ``--index-url`` (see https://github.com/pypiserver/pypiserver/issues/38).
|
2015-09-11 18:40:07 +02:00
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
Please use Github's `bugtracker <https://github.com/pypiserver/pypiserver/issues>`_
|
2016-01-19 20:22:42 +01:00
|
|
|
for other bugs you find.
|
2011-08-01 23:09:42 +02:00
|
|
|
|
|
|
|
|
2011-07-31 23:42:37 +02:00
|
|
|
|
|
|
|
Similar Projects
|
2015-02-27 23:02:07 +01:00
|
|
|
================
|
2011-07-31 23:42:37 +02:00
|
|
|
There are lots of other projects, which allow you to run your own
|
2015-02-27 23:02:07 +01:00
|
|
|
PyPI server. If *pypiserver* doesn't work for you, the following are
|
|
|
|
among the most popular alternatives:
|
2011-07-31 23:42:37 +02:00
|
|
|
|
2015-03-08 17:38:35 +01:00
|
|
|
- `devpi-server <https://pypi.python.org/pypi/devpi-server>`_:
|
2015-09-11 18:40:07 +02:00
|
|
|
a reliable fast pypi.python.org caching server, part of
|
|
|
|
the comprehensive `github-style pypi index server and packaging meta tool
|
2015-03-08 17:38:35 +01:00
|
|
|
<https://pypi.python.org/pypi/devpi>`_.
|
|
|
|
(version: 2.1.4, access date: 8/3/2015)
|
|
|
|
|
2015-09-11 18:40:07 +02:00
|
|
|
- `pip2pi <https://github.com/wolever/pip2pi>`_
|
2015-03-08 17:38:35 +01:00
|
|
|
a simple cmd-line tool that builds a PyPI-compatible local folder from pip requirements
|
|
|
|
(version: 0.6.7, access date: 8/3/2015)
|
2011-08-09 23:47:34 +02:00
|
|
|
|
2016-01-17 19:27:58 +01:00
|
|
|
- `flask-pypi-proxy <http://flask-pypi-proxy.readthedocs.org/>`_
|
|
|
|
A proxy for PyPI that also enables also uploading custom packages.
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
- `twine`_:
|
|
|
|
A command-line utility for interacting with PyPI or *pypiserver*.
|
|
|
|
|
2016-06-23 05:03:40 +02:00
|
|
|
- `pypi-uploader`_:
|
2016-06-23 21:17:13 +02:00
|
|
|
A command-line utility to upload packages to your *pypiserver* from pypi without
|
2016-06-23 05:03:40 +02:00
|
|
|
having to store them locally first.
|
|
|
|
|
2016-06-23 21:17:13 +02:00
|
|
|
- Check this SO question: ` How to roll my own pypi
|
|
|
|
<http://stackoverflow.com/questions/1235331/how-to-roll-my-own-pypi>`_
|
2015-03-08 18:37:34 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
2016-07-02 13:46:09 +02:00
|
|
|
Licensing
|
|
|
|
=========
|
2015-03-08 18:37:34 +01:00
|
|
|
*pypiserver* contains a copy of bottle_ which is available under the
|
|
|
|
*MIT* license, and the remaining part is distributed under the *zlib/libpng* license.
|
2016-06-23 21:17:13 +02:00
|
|
|
See the ``LICENSE.txt`` file.
|
2015-03-08 18:37:34 +01:00
|
|
|
|
2013-05-29 00:15:35 +02:00
|
|
|
|
2015-02-27 23:02:07 +01:00
|
|
|
|
2011-07-31 23:42:37 +02:00
|
|
|
.. _bottle: http://bottlepy.org
|
|
|
|
.. _PyPI: http://pypi.python.org
|
2016-06-23 21:17:13 +02:00
|
|
|
.. _twine: https://pypi.python.org/pypi/twine
|
2016-06-23 05:03:40 +02:00
|
|
|
.. _pypi-uploader: https://pypi.python.org/pypi/pypi-uploader
|
2016-06-24 22:12:29 +02:00
|
|
|
.. _python-pam: https://pypi.python.org/pypi/python-pam/
|
2015-09-11 18:40:07 +02:00
|
|
|
.. |travis-status| image:: https://travis-ci.org/pypiserver/pypiserver.svg
|
|
|
|
:alt: Travis build status
|
2015-03-08 23:21:35 +01:00
|
|
|
:scale: 100%
|
2015-09-11 18:40:07 +02:00
|
|
|
:target: https://travis-ci.org/pypiserver/pypiserver
|
2015-03-08 23:21:35 +01:00
|
|
|
|
2015-09-11 18:40:07 +02:00
|
|
|
.. |pypi-ver| image:: https://img.shields.io/pypi/v/pypiserver.svg
|
2015-03-08 23:21:35 +01:00
|
|
|
:target: https://pypi.python.org/pypi/pypiserver/
|
|
|
|
:alt: Latest Version in PyPI
|
|
|
|
|
2015-09-11 18:40:07 +02:00
|
|
|
.. |python-ver| image:: https://img.shields.io/pypi/pyversions/pypiserver.svg
|
2015-03-08 23:21:35 +01:00
|
|
|
:target: https://pypi.python.org/pypi/pypiserver/
|
2015-09-11 18:40:07 +02:00
|
|
|
:alt: Supported Python versions
|
2015-03-08 23:21:35 +01:00
|
|
|
|
2015-09-11 18:40:07 +02:00
|
|
|
.. |downloads-count| image:: https://img.shields.io/pypi/dm/pypiserver.svg?period=week
|
2015-03-08 23:21:35 +01:00
|
|
|
:target: https://pypi.python.org/pypi/pypiserver/
|
|
|
|
:alt: Downloads
|
|
|
|
|
2015-09-21 04:38:47 +02:00
|
|
|
.. |proj-license| image:: https://img.shields.io/badge/license-BSD%2Bzlib%2Flibpng-blue.svg
|
2015-09-11 18:40:07 +02:00
|
|
|
:target: https://raw.githubusercontent.com/pypiserver/pypiserver/master/LICENSE.txt
|
|
|
|
:alt: Project License
|
|
|
|
|
|
|
|
.. |dependencies| image:: https://img.shields.io/requires/github/pypiserver/pypiserver.svg
|
2016-06-28 13:42:54 +02:00
|
|
|
:target: https://requires.io/github/pypiserver/pypiserver/requirements/
|
2015-09-11 18:40:07 +02:00
|
|
|
:alt: Dependencies up-to-date?
|