Skip to main content

Superwrap: The easy way to contribute to python packages

Superwrap in an extension to virtualenvwrapper that makes it easier to contribute to a python package for the first time.

Here is the current workflow for starting to contribute to a new project for people that use virtualenvwrapper:

$ mkvirtualenv requests
...
(requests)$ ~/Development
(requests)$ git clone git@github.com:kennethreitz/requests.git
...
(requests)$ cd requests
(requests)$ python setup.py develop

And then start working. After setting up Superwrap, it becomes this:

$ workon requests
Setup kennethreitz:requests repo for development
activated
(requests)$ echo "There is no step 2!"

Anytime you use workon with a repo that you don’t already have setup, it will create a new virtualenv, find and clone the repo from github into a new directory, change to that directory, and run python setup.py develop. If you use workon with a virtualenv that has been previously setup, it will work the exact same.

Installation

  • First, have virtualenvwrapper configured.

  • Configure where you want new repos to go by setting the SUPERWRAP_DIR evnrionment variable. It will default to ~/Development.

  • (Optional) Configure GITHUB_OAUTH_TOKEN if you want to create a fork of every repo to clone instead of cloning the repo itself.

  • $ pip install superwrap

  • Add the following to $WORKON_HOME/postactivate

#!/bin/bash
proj_name=$(echo $VIRTUAL_ENV|awk -F'/' '{print $NF}')
cd $SUPERWRAP_DIR/$proj_name

Note that this will create issues if your current setup does not consist of virtualenvs and directories with matching names.

Metadata

Release files for superwrap 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for superwrap 0.0.4
File Size Uploaded
superwrap-0.0.4.tar.gz 2.8 kB Details

Release files / superwrap-0.0.4.tar.gz

Download URL superwrap-0.0.4.tar.gz
Size 2.8 kB
Tags Source
SHA-256 checksum
How to use checksums
a5a6725bf09b6fed4fd61378f6674ebbe8e564f82a4c28af8b614fee0293bb8a
BLAKE2b-256 checksum
How to use checksums
99eea38c5b2b405841b54046700b9b275cbc30e0b04d926eddf0ba9648ee7377
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.0.4 This release

1 release file

0.0.3

1 release file

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page