How to handle python modules in GIT

Question

When I install a python module using pip -t . pip downloads the module into a specific folder in the current directory. Python then searches the current directory for the module when it is imported and all is well.

What is the best practise for whether to add the module folders into GIT?

It seems to me that checking in these folders is not a good idea, instead the build process should download them from the requirements file rather than get them from SCM.

However adding each folder into .gitignore seems overly burdensome.

I was expecting the python modules to go into some special directory such as python_modules which I could then add to .gitignore however this does not appear to be the case. Or is there some kind of hook that I can use to get pip to update the .gitignore file automatically when installing new modules?

So what do people do to manage these files? My googling has so far not revealed much and I am not at a loss as to what to do?

If your project is an application and not a library, consider using a virtual environment to manage your dependencies. Pipenv works well for me. — Kyle Parsons
– Kyle Parsons, Commented Aug 27, 2019 at 15:56
It sounds like you're trying to do something akin to using a virtual environment. I would suggest using conda. — PMende
– PMende, Commented Aug 27, 2019 at 15:56

wpercy · Accepted Answer · 2019-08-27 15:57:51Z

2

One option would be to create a directory called python_modules, and then when you install a new module, install it with pip install -t python_modules .... This way you can add python_modules to your .gitignore.

That being said, what's your rationale behind installing them inside your project rather than letting the build process install them in the usual location on your system?

answered Aug 27, 2019 at 15:57

wpercy

10.2k4 gold badges35 silver badges50 bronze badges

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

3 Comments

CarlR Over a year ago

It comes from writing python Lambda functions where you have to import modules. Are you suggesting that I should not specify the target option and just let Pip install to a system location? I am really just looking for best practise advice.

wpercy Over a year ago

yeah, that's what I'm suggesting. I can't think of a valid reason to require the packages to be installed in your project directory rather than the system location

CarlR Over a year ago

I guess i was expecting Python to work the same way as npm does when adding modules which makes updating gitignore super easy since everything module is contained within the same parent directory. If I were to use a target of python_modules how would you tell Python to look into those directories when importing modules?

Collectives™ on Stack Overflow

How to handle python modules in GIT

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related