New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce a new dependency management tutorial #402

Merged
merged 1 commit into from Nov 29, 2017

Conversation

Projects
None yet
4 participants
@ncoghlan
Member

ncoghlan commented Nov 29, 2017

  • this promotes the draft pipenv tutorial to the main
    guide as a new dependency management tutorial
  • several of the bootstrapping improvements have been
    incorporated into the initial package installation
    tutorial (that still needs more work, but it isn't
    the main focus of this update)
  • the main index page has been rewrapped in editing
  • the "new-tutorials" section has been removed
    completely for the time being (as I'm hoping that
    normal PR reviews will be sufficient for any
    further tutorial updates)
Introduce a new dependency management tutorial
- this promotes the draft pipenv tutorial to the main
  guide as a *new* dependency management tutorial
- several of the bootstrapping improvements have been
  incorporated into the initial package installation
  tutorial (that still needs more work, but it isn't
  the main focus of this update)
- the main index page has been rewrapped in editing
- the "new-tutorials" section has been removed
  completely for the time being (as I'm hoping that
  normal PR reviews will be sufficient for any
  further tutorial updates)
@pfmoore

LGTM

I'm not 100% sure I like the focus on "collaborative" projects. It sounds a bit too advanced. Many of my projects are for my own use exclusively, but I still find managing dependencies and virtual environments a problem. I'd be inclined to describe the pipenv case as "Managing multiple Python projects". Certainly there are many cases where multiple projects can be managed from a single Python environment (as the basic guide describes) but once people start thinking of what they are doing as "managing" more than one "project" (as opposed to, say, "writing a lot of scripts") they are probably at a stage where they can understand and evaluate the advice given in the pipenv-based guide to decide if it's appropriate for them.

But we can review and modify the focus later, so this comment doesn't imply that I want to hold up merging this.

@kennethreitz

This comment has been minimized.

Contributor

kennethreitz commented Nov 29, 2017

🍰

@kennethreitz

This comment has been minimized.

Contributor

kennethreitz commented Nov 29, 2017

When can we expect this to land?

@theacodes theacodes merged commit 7e01f5a into pypa:master Nov 29, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@theacodes

This comment has been minimized.

Member

theacodes commented Nov 29, 2017

When can we expect this to land?

Right meow.

@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Nov 30, 2017

@pfmoore I tend to work on the theory that "me right now" and "me 6 months from now" aren't exactly the same person (since we won't remember exactly the same things), so pre-emptively collaborating with future me is still collaborating :)

@pfmoore

This comment has been minimized.

Member

pfmoore commented Nov 30, 2017

:-) 100% agreed with that. With my memory, "me 5 days from now" might as well be a different person. But nevertheless, to be serious for a moment, I doubt that's what people will think of when they see the word "collaborative". As I say, though, let's see how it works in practice before worrying.

@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Nov 30, 2017

After thinking about it for a while, I realised the key assumption that Pipenv makes that pip doesn't is that you're going to be checking Pipfile and Pipfile.lock into version control. That means the key differentiator isn't really collaboration, it's whether or not you're using version control. I'd just conflated the two, since you can often survive without version control on personal projects, while on collaborative projects it's pretty much essential.

I've tweaked the new bullet point on the main page accordingly: 8564f7f

I haven't reviewed the tutorial intro on that basis, though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment