Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

PyPI clone with Flask and Redis

Project description

https://badge.fury.io/py/cheddar.png https://travis-ci.org/jessemyers/cheddar.png?branch=develop https://pypip.in/d/cheddar/badge.png

PyPI clone with Flask and Redis. It’s the single most popular cheese in the world!

Features

Cheddar aims to simplify Python development within organizations that simultaneously work with public and private Python distributions.

Cheddar includes:

  • A local package index for internal development, supporting setuptools register and upload commands.
  • A remote package index that proxies to a public repository (such as pypi.python.org) and caches packages and package version listings to reduce latency and minimize the effect of downtime by the public repository.
  • A combined package index that unifies the best of the local and remote implementations.

In addition, Cheddar supports a few features that simplify management within an organization:

  • Packages are stored locally in separate directories for pre-releases and releases, simplifying backup strategies that wish to ignore transitive development builds.
  • Duplicate package uploads return a predictable HTTP 409 Conflict error.
  • Mistakenly uploaded packages may be deleted using a simple, RESTful API.

Configuration

Cheddar can run in any WSGI container or through Flask’s built-in development server (which is single-threaded and only recommended for development).

Configuation is loaded from the defaults.py module along with the contents of the file pointed to by the CHEDDAR_SETTINGS environment variable, if any.

You may wish to modify several of the configuration parameters from their default values, including:

  • INDEX_URL which specifies the URL of the remote package index
  • REDIS_HOSTNAME which control the location of the Redis server
  • LOCAL_CACHE_DIR which controls the storage location of locally uploaded files
  • REMOTE_CACHE_DIR which controls the storage location of cached remote files

The Local Index

To use the local index:

  1. Edit your ~/.pypirc to contain an entry for Cheddar. It should look _something_ like:

    [distutils]
    index-servers =
        pypi
        cheddar
    
    [pypi]
    repository:http://pypi.python.org
    
    [cheddar]
    repository:http://localhost:5000/pypi
    username:myusername
    password:mypassword
    

    Note that the URL here assumes you are running the “development” server.

  2. Add credentials to Redis:

    redis-cli set cheddar.user.myusername mypassword
    
  3. Upload your distribution:

    cd /path/to/directory/containing/setup.py
    python setup.py sdist upload -r cheddar
    

    You may also use the register -r cheddar to validate your setup.py without uploading the source distribution.

The Remote Index

Run pip using a custom index url:

pip install --index-url http://localhost:5000/simple

Note that the URL here assumes you are running the “development” server.

You can also edit your ~/.pip/pip.conf to contain the index url automatically:

[install]
index-url = http://localhost:5000/simple

Data

Cheddar saves data in several places:

  • Local packages are stored in the LOCAL_CACHE_DIR
  • Remote packages may be cached in the REMOTE_CACHE_DIR
  • Remote version listings may be cached in Redis.
  • User data (for upload authentication) is stored in Redis.
  • Local package version listings are stored Redis.

History

1.2 (2014-02-21)

  • Allow remote index to work offline if cached.

1.1 (2013-11-22)

  • Add history of uploads.
  • Track uploaded timestamp.
  • Support spidering pypi links to other sites.
  • Improve sort order in UI.

1.0 (2013-11-19)

  • Initial version.

Project details


Release history Release notifications

This version
History Node

1.4

History Node

1.3

History Node

1.2

History Node

1.1.6

History Node

1.1.5

History Node

1.1.4

History Node

1.1.3

History Node

1.1.2

History Node

1.1.1

History Node

1.1

History Node

1.0.2

History Node

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
cheddar-1.4.tar.gz (27.1 kB) Copy SHA256 hash SHA256 Source None Feb 4, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page