Skip to content
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

Added Python version and dependency information to README #112

Merged
merged 1 commit into from
Aug 6, 2012

Conversation

Damgaard
Copy link
Contributor

The authors of #111 and a recent r/learnpython thread both had problems installing PRAW. This was because the user tried using PRAW with python 2.5 when it requires at least 2.6. Adding this information to the README should make it easier for people with a similar problem in the future to trouble shoot.

@bboe
Copy link
Member

bboe commented Jul 31, 2012

PRAW does in fact have dependencies, well one. It's listed here: https://github.com/praw-dev/praw/blob/master/setup.py#L42

However, I prefer to not mention it as pip automatically installs it when PRAW is installed, thus the end-user need not concern themselves with it.

@Damgaard
Copy link
Contributor Author

Damgaard commented Aug 3, 2012

So you would like the README not to contain any mentioning of dependencies at all?

@bboe
Copy link
Member

bboe commented Aug 3, 2012

Well I would say something along the lines of "installation via pip or easy_install will automatically install all of PRAW's dependencies."

@Damgaard
Copy link
Contributor Author

Damgaard commented Aug 3, 2012

Ìnstallation via setup.pyis suggested as an option in README, so writing that would leave people using setup.pywondering what the dependencies are.

@bboe
Copy link
Member

bboe commented Aug 4, 2012

You are correct. In that case, maybe indicate in that section that the user is responsible for installing all the dependencies and link to the setup.py file location.

@Damgaard
Copy link
Contributor Author

Damgaard commented Aug 5, 2012

I would prefer to say that PRAW has a dependency on six, but installing via pip or easyinstall will automatically install the module. That way all the information is in the clear for those who need it, and the rest can read that it will not be something they need to think about.

@bboe
Copy link
Member

bboe commented Aug 5, 2012

I'm cool with that as long as it's clear the typical installation path doesn't require dependencies to be installed manually.

@Damgaard
Copy link
Contributor Author

Damgaard commented Aug 6, 2012

I've updated the pull request with what we've discussed. Does it look better?

@bboe
Copy link
Member

bboe commented Aug 6, 2012

Yes, that looks good. Thanks.

bboe added a commit that referenced this pull request Aug 6, 2012
Added Python version and dependency information to README
@bboe bboe merged commit 1652f03 into praw-dev:master Aug 6, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants