Skip to content

Instantly share code, notes, and snippets.

@carlosmarin

carlosmarin/Private-pypi-howto

Forked from Jaza/Private-pypi-howto
Created May 11, 2018 16:22
Show Gist options
  • Save carlosmarin/8ab75ae14d7c0edb51dbd3a1dc1b1ed3 to your computer and use it in GitHub Desktop.
Save carlosmarin/8ab75ae14d7c0edb51dbd3a1dc1b1ed3 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @Jaza Jaza revised this gist Jun 30, 2015. 1 changed file with 4 additions and 0 deletions.
    4 changes: 4 additions & 0 deletions private_pypi_howto.md
    View file
    Original file line number Diff line number Diff line change
    @@ -2,6 +2,10 @@ How to set up and use a private PyPI repo
    =========================================


    Accompanying blog post:

    [Splitting a Python codebase into dependencies for fun and profit](http://greenash.net.au/thoughts/2015/06/splitting-a-python-codebase-into-dependencies-for-fun-and-profit/)

    Based on:

    [Create a local PyPi repository using only mod_rewrite](https://major.io/2012/01/31/create-a-local-pypi-repository-using-only-mod_rewrite/)
  2. @Jaza Jaza revised this gist Jun 30, 2015. 1 changed file with 2 additions and 1 deletion.
    3 changes: 2 additions & 1 deletion private_pypi_howto.md
    View file
    Original file line number Diff line number Diff line change
    @@ -163,6 +163,7 @@ __version__ = version_line.split('__version__ = ')[-1][1:][:-2]
    setuptools.setup(
    name="foobar-utils",
    version=__version__,
    url="https://git.myserver.com/foobar-utils/",

    author="Mister foo",
    author_email="[email protected]",
    @@ -262,4 +263,4 @@ foobar-utils==0.1.0

    ```
    pip install -r requirements.txt
    ```
    ```
  3. @Jaza Jaza revised this gist Jun 29, 2015. 1 changed file with 15 additions and 0 deletions.
    15 changes: 15 additions & 0 deletions private_pypi_howto.md
    View file
    Original file line number Diff line number Diff line change
    @@ -2,6 +2,21 @@ How to set up and use a private PyPI repo
    =========================================


    Based on:

    [Create a local PyPi repository using only mod_rewrite](https://major.io/2012/01/31/create-a-local-pypi-repository-using-only-mod_rewrite/)

    See also:

    [Local PyPI Options](http://bitofcheese.blogspot.com.au/2013/05/local-pypi-options.html)

    [Setting up a private, team-wide PyPI repository](http://blog.xelnor.net/private-pypi/)

    For a more advanced private PyPI, see:

    [devpi: PyPI server and packaging/testing/release tool](http://doc.devpi.net/)


    Create root directory for private PyPI
    --------------------------------------

  4. @Jaza Jaza revised this gist Jun 29, 2015. 1 changed file with 250 additions and 0 deletions.
    250 changes: 250 additions & 0 deletions private_pypi_howto.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,250 @@
    How to set up and use a private PyPI repo
    =========================================


    Create root directory for private PyPI
    --------------------------------------

    ```
    ssh [email protected]
    ```

    (On remote server)

    ```
    mkdir /path/to/pypi.myserver.com
    mkdir /path/to/pypi.myserver.com/simple
    ```


    Create self-signed SSL certificate
    ----------------------------------

    ```
    sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
    -keyout /etc/apache2/ssl/pypi.myserver.com.key \
    -out /etc/apache2/ssl/pypi.myserver.com.pem
    ```


    Set up Apache vhost
    -------------------

    ```
    sudo htpasswd -c /etc/apache2/passwords_pypi pypi
    ```

    ```
    sudo vi /etc/apache2/sites-available/pypi.myserver.com
    ```

    (Add these lines)

    -----

    ```
    <VirtualHost *:80>
    ServerName pypi.myserver.com
    RewriteEngine On
    RewriteCond %{HTTPS} off
    RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI}
    </VirtualHost>
    <VirtualHost *:443>
    ServerName pypi.myserver.com
    DocumentRoot /data/www/pypi.myserver.com
    SSLEngine On
    SSLCertificateFile /etc/apache2/ssl/pypi.myserver.com.pem
    SSLCertificateKeyFile /etc/apache2/ssl/pypi.myserver.com.key
    <Directory /data/www/pypi.myserver.com/>
    AllowOverride None
    Options +Indexes
    IndexOptions SuppressColumnSorting
    IndexIgnore ..
    Order deny,allow
    Allow from all
    AuthType Basic
    AuthName "My Server"
    AuthBasicProvider file
    AuthUserFile /etc/apache2/passwords_pypi
    Require valid-user
    </Directory>
    LogLevel warn
    ErrorLog /var/log/apache2/pypi-error.log
    CustomLog /var/log/apache2/pypi-access.log combined
    </VirtualHost>
    ```

    -----

    ```
    cd /etc/apache2/sites-enabled
    sudo ln -s ../sites-available/pypi.myserver.com pypi.myserver.com
    sudo apache2ctl graceful
    ```


    Create directory for new library in private PyPI
    ------------------------------------------------

    ```
    mkdir /path/to/pypi.myserver.com/simple/foobar-utils
    ```

    ```
    exit
    ```


    Update library's code
    ---------------------

    (On local machine)

    ```
    cd /path/to/foobar-utils
    ```

    ```
    vi foobar_utils.py
    ```

    (Add these lines)

    -----

    ```python
    __version__ = '0.1.0'

    foobar = 'Hey foo, I am a bar!'
    ```

    -----

    ```
    vi setup.py
    ```

    (Add these lines)

    -----

    ```python
    import os

    import setuptools

    module_path = os.path.join(os.path.dirname(__file__), 'foobar_utils.py')
    version_line = [line for line in open(module_path)
    if line.startswith('__version__')][0]

    __version__ = version_line.split('__version__ = ')[-1][1:][:-2]

    setuptools.setup(
    name="foobar-utils",
    version=__version__,

    author="Mister foo",
    author_email="[email protected]",

    description="Utils for handling Foo and Bar.",
    long_description=open('README.rst').read(),

    py_modules=['foobar_utils'],
    zip_safe=False,
    platforms='any',

    install_requires=[],

    classifiers=[
    'Development Status :: 2 - Pre-Alpha',
    'Environment :: Web Environment',
    'Intended Audience :: Developers',
    'Operating System :: OS Independent',
    'Programming Language :: Python',
    'Programming Language :: Python :: 2',
    'Programming Language :: Python :: 2.7',
    'Programming Language :: Python :: 3',
    'Programming Language :: Python :: 3.3',
    ],
    )
    ```

    -----

    ```
    vi README.rst
    ```

    (Add these lines)

    -----

    ```
    foobar-utils
    ============
    Utils for handling Foo and Bar.
    ```

    -----


    Upload new version of library code to private PyPI
    --------------------------------------------------

    ```
    python setup.py bdist_wheel --universal
    scp dist/foobar_utils-0.1.0-py2.py3-none-any.whl \
    [email protected]:/path/to/pypi.myserver.com/simple/foobar-utils/
    ```


    Configure pip to use private PyPI
    ---------------------------------

    ```
    vi ~/.pip/pip.conf
    ```

    (Add these lines)

    ```
    [global]
    ; Extra index to private pypi dependencies
    extra-index-url = https://pypi:[email protected]/simple/
    trusted-host = pypi.myserver.com
    ```


    Use private library in a project's requirements.txt
    ---------------------------------------------------

    ```
    cd /path/to/projectfoo
    virtualenv .
    source bin/activate
    ```

    ```
    vi requirements.txt
    ```

    (Add these lines)

    -----

    ```
    foobar-utils==0.1.0
    ```

    -----

    ```
    pip install -r requirements.txt
    ```
  5. @Jaza Jaza created this gist Jun 29, 2015.
    1 change: 1 addition & 0 deletions Private-pypi-howto
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1 @@
    *