This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

Principles

  • Declarative configuration based
  • Configurable path for the virtualenvs and the symlinks
  • Support one or many virtualenvs
  • Idempotent

Example

Consider the following example.yaml:

.demo_sysvenv3:
    triforce:
        venv_prefix: /tmp/example
        symlink_prefix: /tmp/example
        install: true
    ipython:
        symlink: ['ipython', 'iptest']
    yadoma: {}
.demo_sysvenv2:
    triforce:
        venv_command: python2
        venv_prefix: /tmp/example
        symlink_prefix: /tmp/example
    git-spindle:
        url: git+ssh://git@github.com/seveas/git-spindle.git
        symlink: ['git-hub']

This will create two system virtualenvs .demo_sysvenv3 and .demo_sysvenv2. The first, is based on Python 3 (the default) and the second on legacy Python. Each system virtualenv contains a number of packages that will be installed and linked.

The special triforce section contains additional parameters that govern how the system virtualenv will be configured. For example in both cases above, the virtualenvs themselves and their symlinks will be installed into /tmp/example (to ensure the example doesn’t screw with your system). In the .demo_sysvenv2 case, the venv_command command has been set to python2 indicating that a virtualenv with legacy python should be installed. In case the command it uses under the hood (use the force, read the source) doesn’t work for you, you can also simply type a custom command string to create the virtualenv for you. This is provided as a fallback since there seem to be a myriad of ways of setting up a virtualenv and you never know what might work on a given system. Lastly setting install to true will ensure that the triforce itself is installed and symlinked into the virtual environment, meaning you can delete whatever you used to bootstrap it.

In addition to the names of the packages on PyPi, you need to specify which executables or scripts should be symlinked. This may seem redundant, but a) I don’t know how to easily introspect a Python package to obtain the scripts it installs and b) maybe you want to have control over this. Anyway, for the tool yadoma above there is no list of symlinks and so the tool will attempt to symlink a script of the same name as the package on PyPi. Yes, this could have been done for ipython too, but then we wouldn’t link the iptest script. Lastly, you can also specify a url which may contain the string that will be passed on to pip. In the example above we install git-spindle from github.

Lastly, I should also note that the tools pip and pybuilder will be installed by default into each created system virtualenv.

Here is what it looks like in action:

% triforce example.yaml
{'name': '.demo_sysvenv3', 'symlinks': ['ipython', 'iptest', 'yadoma'], 'symlink_prefix': '/tmp/example', 'venv_command': 'python3', 'urls': ['ipython', 'yadoma'], 'venv_prefix': '/tmp/example', 'path': '/tmp/example/.demo_sysvenv3'}
Creating venv at: '/tmp/example/.demo_sysvenv3'

'pip' command is: '/tmp/example/.demo_sysvenv3/bin/pip'
Installing/upgrading utilities: 'pip' and 'pybuilder'
Collecting pip
  Using cached pip-8.1.2-py2.py3-none-any.whl
Installing collected packages: pip
  Found existing installation: pip 8.1.1
    Uninstalling pip-8.1.1:
      Successfully uninstalled pip-8.1.1
Successfully installed pip-8.1.2

Collecting pybuilder
Requirement already up-to-date: pip>=7.0 in /tmp/example/.demo_sysvenv3/lib/python3.5/site-packages (from pybuilder)
Collecting wheel (from pybuilder)
  Using cached wheel-0.29.0-py2.py3-none-any.whl
Collecting tblib (from pybuilder)
  Using cached tblib-1.3.0-py2.py3-none-any.whl
Installing collected packages: wheel, tblib, pybuilder
Successfully installed pybuilder-0.11.9 tblib-1.3.0 wheel-0.29.0

Installing dependencies: '['ipython', 'yadoma']'
Collecting ipython
  Using cached ipython-5.1.0-py3-none-any.whl
Collecting yadoma
Collecting traitlets>=4.2 (from ipython)
  Using cached traitlets-4.3.0-py2.py3-none-any.whl
Collecting pygments (from ipython)
  Using cached Pygments-2.1.3-py2.py3-none-any.whl
Collecting prompt-toolkit<2.0.0,>=1.0.3 (from ipython)
  Using cached prompt_toolkit-1.0.7-py3-none-any.whl
Collecting decorator (from ipython)
  Using cached decorator-4.0.10-py2.py3-none-any.whl
Collecting simplegeneric>0.8 (from ipython)
Collecting pexpect; sys_platform != "win32" (from ipython)
  Using cached pexpect-4.2.1-py2.py3-none-any.whl
Requirement already satisfied (use --upgrade to upgrade): setuptools>=18.5 in /tmp/example/.demo_sysvenv3/lib/python3.5/site-packages (from ipython)
Collecting pickleshare (from ipython)
  Using cached pickleshare-0.7.4-py2.py3-none-any.whl
Collecting pyyaml (from yadoma)
Collecting docopt (from yadoma)
Collecting six (from traitlets>=4.2->ipython)
  Using cached six-1.10.0-py2.py3-none-any.whl
Collecting ipython-genutils (from traitlets>=4.2->ipython)
  Using cached ipython_genutils-0.1.0-py2.py3-none-any.whl
Collecting wcwidth (from prompt-toolkit<2.0.0,>=1.0.3->ipython)
  Using cached wcwidth-0.1.7-py2.py3-none-any.whl
Collecting ptyprocess>=0.5 (from pexpect; sys_platform != "win32"->ipython)
  Using cached ptyprocess-0.5.1-py2.py3-none-any.whl
Installing collected packages: six, decorator, ipython-genutils, traitlets, pygments, wcwidth, prompt-toolkit, simplegeneric, ptyprocess, pexpect, pickleshare, ipython, pyyaml, docopt, yadoma
Successfully installed decorator-4.0.10 docopt-0.6.2 ipython-5.1.0 ipython-genutils-0.1.0 pexpect-4.2.1 pickleshare-0.7.4 prompt-toolkit-1.0.7 ptyprocess-0.5.1 pygments-2.1.3 pyyaml-3.12 simplegeneric-0.8.1 six-1.10.0 traitlets-4.3.0 wcwidth-0.1.7 yadoma-41.3

Will symlink: '/tmp/example/.demo_sysvenv3/bin/ipython' --> '/tmp/example/ipython'
Will symlink: '/tmp/example/.demo_sysvenv3/bin/iptest' --> '/tmp/example/iptest'
Will symlink: '/tmp/example/.demo_sysvenv3/bin/yadoma' --> '/tmp/example/yadoma'
{'name': '.demo_sysvenv2', 'symlinks': ['git-hub'], 'symlink_prefix': '/tmp/example', 'venv_command': 'python2', 'urls': ['git+ssh://git@github.com/seveas/git-spindle.git'], 'venv_prefix': '/tmp/example', 'path': '/tmp/example/.demo_sysvenv2'}
Creating venv at: '/tmp/example/.demo_sysvenv2'
Running virtualenv with interpreter /usr/bin/python2
New python executable in /tmp/example/.demo_sysvenv2/bin/python2
Also creating executable in /tmp/example/.demo_sysvenv2/bin/python
Installing setuptools, pkg_resources, pip, wheel...done.

'pip' command is: '/tmp/example/.demo_sysvenv2/bin/pip'
Installing/upgrading utilities: 'pip' and 'pybuilder'
Requirement already up-to-date: pip in /tmp/example/.demo_sysvenv2/lib/python2.7/site-packages

Collecting pybuilder
Requirement already up-to-date: pip>=7.0 in /tmp/example/.demo_sysvenv2/lib/python2.7/site-packages (from pybuilder)
Collecting tblib (from pybuilder)
  Using cached tblib-1.3.0-py2.py3-none-any.whl
Requirement already up-to-date: wheel in /tmp/example/.demo_sysvenv2/lib/python2.7/site-packages (from pybuilder)
Installing collected packages: tblib, pybuilder
Successfully installed pybuilder-0.11.9 tblib-1.3.0

Installing dependencies: '['git+ssh://git@github.com/seveas/git-spindle.git']'
Collecting git+ssh://git@github.com/seveas/git-spindle.git
  Cloning ssh://git@github.com/seveas/git-spindle.git to /tmp/pip-wqHeBB-build
Collecting github3.py>=0.9.0 (from git-spindle==3.3)
  Using cached github3.py-0.9.5-py2.py3-none-any.whl
Collecting whelk>=2.6 (from git-spindle==3.3)
Collecting docopt>=0.5.0 (from git-spindle==3.3)
Collecting uritemplate.py>=0.2.0 (from github3.py>=0.9.0->git-spindle==3.3)
  Downloading uritemplate.py-3.0.2-py2.py3-none-any.whl
Collecting requests>=2.0 (from github3.py>=0.9.0->git-spindle==3.3)
  Using cached requests-2.11.1-py2.py3-none-any.whl
Collecting uritemplate>=2.0 (from uritemplate.py>=0.2.0->github3.py>=0.9.0->git-spindle==3.3)
  Downloading uritemplate-3.0.0-py2.py3-none-any.whl
Installing collected packages: uritemplate, uritemplate.py, requests, github3.py, whelk, docopt, git-spindle
  Running setup.py install for git-spindle ... done
Successfully installed docopt-0.6.2 git-spindle-3.3 github3.py-0.9.5 requests-2.11.1 uritemplate-3.0.0 uritemplate.py-3.0.2 whelk-2.6

Will symlink: '/tmp/example/.demo_sysvenv2/bin/git-hub' --> '/tmp/example/git-hub'

TODO and Ideas

Many.

License

Copyright 2016 Valentin Haenel <valentin@haenel.co>

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Release History

Release History

53.6

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

52.5

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

51.4

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0.dev0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
triforce-53.6.tar.gz (5.4 kB) Copy SHA256 Checksum SHA256 Source Sep 21, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting