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

Chore: Clarified pip install instructions #277

Closed

Conversation

kenibrewer
Copy link
Member

Description

Clarification in documentation that resolves #253 and will better support anonymous installs of pycytominer from users unfamiliar with the syntax of pip install git+ commands.

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • I have deleted all non-relevant text in this pull request template.

@codecov-commenter
Copy link

Codecov Report

Merging #277 (9a5888b) into master (a5ae6c8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #277   +/-   ##
=======================================
  Coverage   95.07%   95.07%           
=======================================
  Files          57       57           
  Lines        3044     3044           
=======================================
  Hits         2894     2894           
  Misses        150      150           
Flag Coverage Δ
unittests 95.07% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@kenibrewer kenibrewer changed the title Chore: Clarified pip install instructions #253 Chore: Clarified pip install instructions May 3, 2023
@danodonovan
Copy link

This change is preferred by PyPI

The use of git, git+git, and git+http schemes is discouraged. The former two use the Git Protocol, which lacks authentication, and HTTP is insecure due to lack of TLS based encryption.

https://pip.pypa.io/en/stable/topics/vcs-support/

@kenibrewer
Copy link
Member Author

@gwaybio Could I get a review on this PR?

Copy link
Member

@gwaybio gwaybio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're currently working toward a version 1 release, which will change the instructions in the README. For us to merge a pip install clarification, I think it is worth removing the pip + git install commands in favor of pip alone (also adding reference to pycytominer on conda) and all other references to pycytominer still being in beta.

@kenibrewer
Copy link
Member Author

Superseded by #289

@kenibrewer kenibrewer closed this Jun 11, 2023
@kenibrewer kenibrewer deleted the chore/clarify-pip-install branch June 11, 2023 20:58
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.

pip install git+git isn't working
4 participants