OpenAdapt
OpenAdapt copied to clipboard
Add documentation for using pyenv with poetry
PR Feedback: 👎
Description
This PR adds documentation to the README.md file on how to use pyenv
with poetry
in the OpenAdapt project. It provides instructions for users who do not have the required Python version installed and need to manage Python versions using pyenv
.
Summary of Changes
- Added a new section titled "Managing Python Versions with Pyenv" after the "Manual Setup" section in the README.md file.
- Explained what
pyenv
is and how it can be used to switch between multiple versions of Python. - Provided a link to the
pyenv
GitHub repository for more detailed information and installation instructions. - Included step-by-step instructions on how to use
pyenv
to install the required Python version and set it as the local version for the OpenAdapt project. - Mentioned that after setting the local Python version with
pyenv
, users can proceed with the "Manual Setup" instructions as usual.
Please review and merge this PR to add documentation for using pyenv
with poetry
in the OpenAdapt project.
Fixes #508.
🎉 Latest improvements to Sweep:
- Sweep now uses the
rope
library to refactor Python! Check out Large Language Models are Bad at Refactoring Code. To have Sweep refactor your code, trysweep: Refactor <your_file>.py to be more modular
! - Sweep finds and fixes bugs in your code by writing unit tests! Check out Having GPT-4 Iterate on Unit Tests like a Human.
💡 To get Sweep to edit this pull request, you can:
- Comment below, and Sweep can edit the entire PR
- Comment on a file, Sweep will only modify the commented file
- Edit the original issue to get Sweep to recreate the PR from scratch
Sandbox Executions
- [X] Check
README.md
✗
Sandbox logs for
trunk fmt README.md || exit 0
1/2 ✓✔ Formatted README.md Re-checking autofixed files... Checked 1 file ✔ No issues
trunk check --fix --print-failures README.md
2/2 ❌ (`1`)ISSUES README.md:86:0 1:0 low First line in a file should be a top-level heading markdownlint/MD041 5:0 low Heading levels should only increment by one level at a time markdownlint/MD001 5:0 low Trailing punctuation in heading markdownlint/MD026 7:0 low Trailing punctuation in heading markdownlint/MD026 9:0 low Trailing punctuation in heading markdownlint/MD026 86:0 low Fenced code blocks should have a language specified markdownlint/MD040 90:0 low Fenced code blocks should have a language specified markdownlint/MD040 94:0 low Fenced code blocks should have a language specified markdownlint/MD040 102:0 low Fenced code blocks should have a language specified markdownlint/MD040 122:0 low Fenced code blocks should have a language specified markdownlint/MD040 128:0 low Fenced code blocks should have a language specified markdownlint/MD040 151:0 low Fenced code blocks should have a language specified markdownlint/MD040 163:0 low Fenced code blocks should have a language specified markdownlint/MD040 171:0 low Link fragments should be valid markdownlint/MD051 220:0 low Link fragments should be valid markdownlint/MD051 260:0 low Trailing punctuation in heading markdownlint/MD026 283:0 low Fenced code blocks should have a language specified markdownlint/MD040 307:0 low Fenced code blocks should have a language specified markdownlint/MD040 Checked 1 file 15 existing issues ✖ 3 new issues
- [X] Check
README.md
✗
Sandbox logs for
trunk fmt README.md || exit 0
1/2 ✓✔ Formatted README.md Re-checking autofixed files... Checked 1 file ✔ No issues
trunk check --fix --print-failures README.md
2/2 ❌ (`1`)ISSUES README.md:9:0 1:0 low First line in a file should be a top-level heading markdownlint/MD041 9:0 low Heading levels should only increment by one level at a time markdownlint/MD001 21:0 low Trailing punctuation in heading markdownlint/MD026 80:0 low Multiple headings with the same content markdownlint/MD024 195:0 low Multiple headings with the same content markdownlint/MD024 199:0 low Fenced code blocks should have a language specified markdownlint/MD040 207:0 low Link fragments should be valid markdownlint/MD051 225:0 low Multiple headings with the same content markdownlint/MD024 256:0 low Link fragments should be valid markdownlint/MD051 296:0 low Trailing punctuation in heading markdownlint/MD026 319:0 low Fenced code blocks should have a language specified markdownlint/MD040 343:0 low Fenced code blocks should have a language specified markdownlint/MD040 Checked 1 file 8 existing issues ✖ 4 new issues
- [X] Check
README.md
✗
Sandbox logs for
trunk fmt README.md || exit 0
1/2 ✓✔ Formatted README.md Re-checking autofixed files... Checked 1 file ✔ No issues
trunk check --fix --print-failures README.md
2/2 ❌ (`1`)ISSUES README.md:72:0 1:0 low First line in a file should be a top-level heading markdownlint/MD041 72:0 low Multiple headings with the same content markdownlint/MD024 202:0 low Multiple headings with the same content markdownlint/MD024 233:0 low Link fragments should be valid markdownlint/MD051 273:0 low Trailing punctuation in heading markdownlint/MD026 292:0 low Multiple headings with the same content markdownlint/MD024 300:0 low Multiple headings with the same content markdownlint/MD024 309:0 low Fenced code blocks should have a language specified markdownlint/MD040 333:0 low Fenced code blocks should have a language specified markdownlint/MD040 Checked 1 file 5 existing issues ✖ 4 new issues
- [X] Check
README.md
✗
Run `README.md` through the sandbox.
- [X] Check
README.md
✗
Sandbox logs for
trunk fmt README.md || exit 0
1/2 ✓✔ Formatted README.md Re-checking autofixed files... Checked 1 file ✔ No issues
trunk check --fix --print-failures README.md
2/2 ❌ (`1`)ISSUES README.md:72:0 1:0 low First line in a file should be a top-level heading markdownlint/MD041 72:0 low Multiple headings with the same content markdownlint/MD024 202:0 low Multiple headings with the same content markdownlint/MD024 233:0 low Link fragments should be valid markdownlint/MD051 273:0 low Trailing punctuation in heading markdownlint/MD026 292:0 low Multiple headings with the same content markdownlint/MD024 300:0 low Multiple headings with the same content markdownlint/MD024 309:0 low Fenced code blocks should have a language specified markdownlint/MD040 333:0 low Fenced code blocks should have a language specified markdownlint/MD040 Checked 1 file 5 existing issues ✖ 4 new issues
- [X] Check
README.md
✗
Sandbox logs for
trunk fmt README.md || exit 0
1/2 ✓✔ Formatted README.md Re-checking autofixed files... Checked 1 file ✔ No issues
trunk check --fix --print-failures README.md
2/2 ❌ (`1`)ISSUES README.md:9:0 1:0 low First line in a file should be a top-level heading markdownlint/MD041 9:0 low Heading levels should only increment by one level at a time markdownlint/MD001 21:0 low Trailing punctuation in heading markdownlint/MD026 80:0 low Multiple headings with the same content markdownlint/MD024 195:0 low Multiple headings with the same content markdownlint/MD024 199:0 low Fenced code blocks should have a language specified markdownlint/MD040 207:0 low Link fragments should be valid markdownlint/MD051 225:0 low Multiple headings with the same content markdownlint/MD024 256:0 low Link fragments should be valid markdownlint/MD051 296:0 low Trailing punctuation in heading markdownlint/MD026 319:0 low Fenced code blocks should have a language specified markdownlint/MD040 343:0 low Fenced code blocks should have a language specified markdownlint/MD040 Checked 1 file 8 existing issues ✖ 4 new issues
- [X] Check
README.md
✗
Sandbox logs for
trunk fmt README.md || exit 0
1/2 ✓✔ Formatted README.md Re-checking autofixed files... Checked 1 file ✔ No issues
trunk check --fix --print-failures README.md
2/2 ❌ (`1`)ISSUES README.md:86:0 1:0 low First line in a file should be a top-level heading markdownlint/MD041 5:0 low Heading levels should only increment by one level at a time markdownlint/MD001 5:0 low Trailing punctuation in heading markdownlint/MD026 7:0 low Trailing punctuation in heading markdownlint/MD026 9:0 low Trailing punctuation in heading markdownlint/MD026 86:0 low Fenced code blocks should have a language specified markdownlint/MD040 90:0 low Fenced code blocks should have a language specified markdownlint/MD040 94:0 low Fenced code blocks should have a language specified markdownlint/MD040 102:0 low Fenced code blocks should have a language specified markdownlint/MD040 122:0 low Fenced code blocks should have a language specified markdownlint/MD040 128:0 low Fenced code blocks should have a language specified markdownlint/MD040 151:0 low Fenced code blocks should have a language specified markdownlint/MD040 163:0 low Fenced code blocks should have a language specified markdownlint/MD040 171:0 low Link fragments should be valid markdownlint/MD051 220:0 low Link fragments should be valid markdownlint/MD051 260:0 low Trailing punctuation in heading markdownlint/MD026 283:0 low Fenced code blocks should have a language specified markdownlint/MD040 307:0 low Fenced code blocks should have a language specified markdownlint/MD040 Checked 1 file 15 existing issues ✖ 3 new issues
Apply Sweep Rules to your PR?
- [ ] Apply: All new business logic should have corresponding unit tests.
- [ ] Apply: Refactor large functions to be more modular.