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 Readme #174

Merged
merged 3 commits into from
Dec 18, 2024
Merged

Update Readme #174

merged 3 commits into from
Dec 18, 2024

Conversation

KrishnaTO
Copy link
Contributor

@KrishnaTO KrishnaTO commented Dec 13, 2024

Fixed typo from old style git clone url

Encountered error installing in local, using Python v3.12.3, getting 'Externally managed environment' error. Per PEP 668, use of an environment resolves this error.

Alternatively for installing from pip (not from local clone), pipx is required for "External packages" per error.

Please feel free to review and update as needed.

Updated git clone URL matching http method
Added venv-based environment to resolve 'Externally managed environment' error from [PEP 668|https://peps.python.org/pep-0668/] Updated pip installation to pipx, as required for external packages

Updated git clone URL matching http method
Added venv-based environment to resolve 'Externally managed environment' error from [PEP 668|https://peps.python.org/pep-0668/]
Updated pip installation to pipx, as required for external packages
Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (master@1a03dc7). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #174   +/-   ##
=========================================
  Coverage          ?   28.64%           
=========================================
  Files             ?       16           
  Lines             ?     1351           
  Branches          ?      180           
=========================================
  Hits              ?      387           
  Misses            ?      950           
  Partials          ?       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@KrishnaTO KrishnaTO closed this Dec 13, 2024
@KrishnaTO KrishnaTO deleted the readme-updates-1 branch December 13, 2024 18:09
@KrishnaTO KrishnaTO restored the readme-updates-1 branch December 13, 2024 18:10
@KrishnaTO KrishnaTO reopened this Dec 13, 2024
@cthoyt
Copy link
Member

cthoyt commented Dec 16, 2024

Hi @KrishnaTO, thanks for pointing this out, but there are so many ways to make virtual environments that documenting just one specific way how to do this is out of scope for this package's installation documentation.

I'm not sure using a virtual environment is even the root cause for your error - can you please include the full code that you ran in the shell and the full output?

However, the typo fix for git+https is helpful, would you mind making a self-contained contribution with just that?

@KrishnaTO KrishnaTO changed the title Update Readme - add venv to resolve 'Externally managed environment' Update Readme Dec 16, 2024
@KrishnaTO
Copy link
Contributor Author

Done, but let me know if a separate pull request is better?

@cthoyt
Copy link
Member

cthoyt commented Dec 17, 2024

will merge this after addressing cruft updates in a different PR

@cthoyt cthoyt merged commit acef844 into biopragmatics:master Dec 18, 2024
9 checks passed
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