Developing Python Module

Question

I'd like to start developing an existing Python module. It has a source folder and the setup.py script to build and install it. The build script just copies the source files since they're all python scripts.

Currently, I have put the source folder under version control and whenever I make a change I re-build and re-install. This seems a little slow, and it doesn't settle well with me to "commit" my changes to my python install each time I make a modification. How can I cause my import statement to redirect to my development directory?

samplebias · Accepted Answer · 2011-04-15 15:59:32Z

23

Use a virtualenv and use python setup.py develop to link your module to the virtual Python environment. This will make your project's Python packages/modules show up on the sys.path without having to run install.

Example:

% virtualenv ~/virtenv
% . ~/virtenv/bin/activate
(virtenv)% cd ~/myproject
(virtenv)% python setup.py develop

answered Apr 15, 2011 at 15:59

samplebias

38.1k6 gold badges111 silver badges104 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

arie · Accepted Answer · 2011-04-15 20:14:24Z

Virtualenv was already mentioned.

And as your files are already under version control you could go one step further and use Pip to install your repo (or a specific branch or tag) into your working environment.

See the docs for Pip's editable option:

-e VCS+REPOS_URL[@REV]#egg=PACKAGE, --editable=VCS+REPOS_URL[@REV]#egg=PACKAGE

Install a package directly from a checkout. Source will be checked out into src/PACKAGE (lower-case) and installed in-place (using setup.py develop).

Now you can work on the files that pip automatically checked out for you and when you feel like it, you commit your stuff and push it back to the originating repository.

To get a good, general overview concerning Pip and Virtualenv see this post: http://www.saltycrane.com/blog/2009/05/notes-using-pip-and-virtualenv-django

Keith · Accepted Answer · 2011-04-15 16:05:56Z

2

Install the distrubute package then use the developer mode. Just use python setup.py develop --user and that will place path pointers in your user dir location to your workspace.

answered Apr 15, 2011 at 16:05

Keith

43.2k11 gold badges62 silver badges77 bronze badges

1 Comment

Paolo Over a year ago

the develop option is also supported with plain setuptools and without installing distribute (in case one doesn't want to).

Pablo · Accepted Answer · 2011-04-15 16:01:04Z

1

Change the PYTHONPATH to your source directory. A good idea is to work with an IDE like ECLIPSE that overrides the default PYTHONPATH.

answered Apr 15, 2011 at 16:01

Pablo

4005 silver badges12 bronze badges

1 Comment

Gus Over a year ago

@Sentinel, could you elaborate please?

Collectives™ on Stack Overflow

Developing Python Module

4 Answers 4

Comments

Comments

1 Comment

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related