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.

Sign up for GitHub

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

Explaining PyCharm setup #121

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Explaining PyCharm setup #121

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
35d3213
Explaining PyCharm setup
greg-at-moderne Jan 13, 2025
2ea928b
Merge remote-tracking branch 'origin/main' into pycharm-setup
greg-at-moderne Jan 15, 2025
72e8276
update PyCharm installation instructions to use rewrite/ as project root
greg-at-moderne Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,21 @@ In the setup described here it is at the time of writing important that the GitH
7. Create a new run configuration which runs the Python module `rewrite_remote.server` (typically in debug mode)
8. Now open `~/git/openrewrite/rewrite-python` in a second IDEA workspace and run the JUnit tests from there


### PyCharm setup

(tested using ```PyCharm 2024.3.1.1 (Community Edition)```)

In order to conveniently perform development and run tests from within PyCharm one can:
1. Open the `~/git/openrewrite/rewrite-python` as project.
2. Configure the virtual environment interpret with:
- PyCharm | Settings | Project: rewrite-python | Python Interpreter | Add Interpreter | Add Local Interpreter
- Select Existing
- Python path - navigate to `rewrite-python/rewrite/.venv/bin/python`
3. (Right-click to) mark `rewrite` (not `rewrite/rewrite`) as Sources Root
4. (Right-click to) mark `rewrite/tests/python/all` as Test Sources Root


### Resources

- [Python Builtins](https://docs.python.org/3/library/functions.html), which are sometimes used to desugar syntax.
Expand Down
Loading