[MRG] Pipfile for repo2Docker

[trallard]

Description

WIP: this PR should allow for repo2docker to use Pipfiles

Updated checklist:

• My code follows the style guidelines of this project
• I have made corresponding changes to the documentation
• I have made corresponding changes to the contributing guidelines
• My changes generate no new warnings
• New and existing unit tests pass locally with my changes

[betatim]

Whoop! Getting this done will be cool.

Just to double check: so far this PR (still work in progress) adds a Pipfile to the root of the repo which let's us install repo2docker via pipenv. The linked issue is about being able to build repos that specify their dependencies via a Pipfile. Is that where this PR is going?

[trallard]

Hi yes! The intention of the PR is to enable the use of Pipfiles for dependencies specification while using repo2docker to dockerize repositories (sorry for the redundancy).

I added the Pipfile for my personal use (as I use now pipenv for my dev environments).
I can leave this out of the final PR once this is ready to merge or leave it if anyone believes this will help people/contributors in any way .

[minrk]

Awesome! I'm excited to get this feature.

[betatim]

I think the biggest (and only) downside to having a Pipfile for setting up repo2docker is that we have two places (?) to keep up to date for specifying dependencies but that seems like a not so big problem. And probably something that can be solved with some automation?? -> I'd leave it in (or if the Pipfile-for-repo2docker is ready we merge this PR now and make a new one for repo2docker-learns-how-to-read-pipfiles?

[choldgraf]

woo! I agree this will be a great feature. @trallard you are giving @consideRatio a challenge for "well-structured and formatted PR top-comments" :-)

[trallard]

think the biggest (and only) downside to having a Pipfile for setting up repo2docker is that we have two places (?) to keep up to date for specifying dependencies but that seems like a not so big problem. And probably something that can be solved with some automation??

This is always something I worry about. A way around it would be to keep the Pipfile updated and upon any update to the dependencies generate a requirements.txt via pipenv.

Also, I this PR is on hold until perhaps next week(ish) since I will be attending conferences in the upcoming days

[choldgraf]

I'd be +1 on programmatically generating the requirements.txt if we're worried that we'll forget to update one or the other (IMO the potential future value of pipfiles makes it worth it though!)

[choldgraf]

hey @trallard - just a friendly ping on this one!

[trallard]

Oh sorry I thought I had replied. I have been away for conferences and will only be able to work on this next week.

It will work on both PRs as suggested by @betatim.
Would it then be best to have the Profile as the record of truth and then programmatically generate the requirements.txt programmatically? i e. as part of the CI/CD

[choldgraf]

I'd be +1 on that...but maybe not necessary for this PR? In the short-term we can remember to update two sets of dependencies (perhaps you could add some language about the pipfile here: https://repo2docker.readthedocs.io/en/latest/contributing/tasks.html#update-and-freeze-buildpack-dependencies ?)

also, no need to say sorry! just a ping :-)

[betatim]

For simplicity I'd say let's go with no automation (less likely to break and need maintenance). It doesn't seem to be a common task to update the things repo2docker itself depends on. Maybe add a comment in the two places pointing to the other place.

[betatim]

LGTM once we resolve that one question about yaml.

Should the Pipfile <-> requirements file cross linking also mention https://github.com/jupyter/repo2docker/blob/master/docs/doc-requirements.txt as the Pipfile takes care of that as well?

[betatim]

If travis is happy I am happy.

[trallard]

@betatim this should fix the issues with Travis CI and I have now added the missing refs to the doc-requirements.txt too

[choldgraf]

I think we need one fewer header level here (or one later header level after)

[trallard]

Actually, I think this heading could be completely removed since we already have a Setting up for Local Development

[choldgraf]

The docs look good! I am a little bit confused: looking at the "files changed" I can't see any of the python modules being changed anymore...am I being silly and missing something here?

[betatim]

@choldgraf we decided to split this PR into two:

1. adds a Pipfile so you can use pipenv to install repo2docker (this PR)
2. a new PR that adds support to repo2docker so that it understands Pipfiles

[choldgraf]

ahhh I see, sorry for the noise :-)

[betatim]

Done and dusted! Thanks for this and looking forward to the next PR :)

[consideRatio]

Wohooo nice work! :D

[betatim]

@trallard does your agenda have room for working on Pipfile support for creating images with repo2docker?

I'd like to make a release in a week but at some point said we'd wait for having Pipfile support. Now I am thinking we should get the release out (so that we build up some cadence on releasing) and don't wait (as there will be a next release soon after). How does that work for you?

[trallard]

heyo! I was meant to work on this last Friday but got sidetracked with the workshop applications

I have time this Friday and weekend to work on the PR but I wonder if this would be enough to work on the code and you folks to review the request.
Also, I do not want to hold this release either so perhaps can delay the Pipfile support for the upcoming release if this is not too far away

[betatim]

Whatever is the least amount of stress. I'd make the release now, then you add the code and we make a new release in January or so? mybinder.org runs master of repo2docker so even without a release things get out :)

[trallard]

Fab! let's make this the plan and I will anyway make sure to make as much progress as possible over this weekend 😄

[betatim]

Sure thing, or do something away from the glowing rectangle that is a computer :)

[choldgraf]

🎉