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

Update requirements.txt and README.rst #6

Merged
merged 3 commits into from Mar 31, 2019

Conversation

chanita
Copy link
Contributor

@chanita chanita commented Mar 30, 2019

  • Add robotframework-seleniumlibrary as a dependency in requirement.txt.
  • Update README.rst to use pip install -r requirement.txt

Chanita Anuwong and others added 3 commits March 30, 2019 13:41
@aaltat aaltat merged commit dc0ae4a into robotframework:master Mar 31, 2019
@aaltat
Copy link
Contributor

aaltat commented Mar 31, 2019

Thank you for the enhancement. All looks good and PR is merged.

@pekkaklarck
Copy link
Member

Are you sure this is a good idea?

  • Normal users don't need Invoke or other stuff in requirements.txt.
  • pip install robotframework-seleniumlibrary isn't any more complicated than pip install -r requirements.txt. In fact I consider the former simpler and easier to explain.

@aaltat
Copy link
Contributor

aaltat commented Mar 31, 2019

For me requirements.txt feels better, although I agree that the project is not meant for users like me. Instead project is meant for users that are new in Python or/and Robot Framework. For those users the txt file can feel even stranger.

When you did say it out loud, I am starting to second guess me. Also I can not decide what would be better. Opinions?

@pekkaklarck
Copy link
Member

pekkaklarck commented Mar 31, 2019

If requirements.txt is used, these additional changes are needed:

  • Split dev requirements to separate requirements-dev.txt
  • Explain that you need to be in the same directory that requirements.txt (or use relative path)
  • Remove references to SL installation instructions because they aren't relevant.

In my opinion the above isn't worth the effort and I'm afraid instructions would end up being more complicated than they used to be.

What I'd do instead:

  • In README just have pip install robotframework-seleniumlibrary with a note that it install also RF.
  • Link RF and SL installation instructions as a reference.
  • Have dev requirements in requirements-dev.txt. Should be mentioned in BUILD.
  • Possibly have normal requirements in requirements.txt. Shouldn't be mention it in README to avoid confusion.

@pekkaklarck
Copy link
Member

@aaltat What do you think about my comment above? The current requirements.txt with dev requirements is not a good idea at all. If you have nothing against it, I'll change installation instructions to contain just pip install robotframework-seleniumlibrary and do other changes I propose above.

@aaltat
Copy link
Contributor

aaltat commented May 21, 2019

Sorry, I did forget that I did promise to fix this.

But I think you are right and requirements.txt is not good idea and we should do the instead part you did propose.

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.

None yet

3 participants