This project assumes you use PyCharm Community Edition 2024.1 or higher.
Experienced python developers will be able to interact with this project entirely through a well-configured terminal.
We require python 3.12 or higher for this project. See Python's installation instructions for the best way to get python on your platform.
We use uv to manage our third-party python dependencies. The linked documentation includes one-time installation instructions.
The following documentation from PyCharm walks through the details of adding a new python interpreter/runtime to PyCharm. During this process, we will notify PyCharm of the location of our python binary, and our package manager, uv.
After setting up the project's interpreter, open up the IDE's terminal and execute uv sync to download all dependencies.
Failure to run this command will cause future terminal commands to fail.
| Task | Command |
|---|---|
| Install dependencies | uv sync |
| Execute unit tests | pytest . |
| Format python code | black . |
| Verify type correctness | mypy . |
We cannot easily ship IDE configuration files, meaning users will need to add run configurations on their own.
.
In summary:
- Select the combo box in the top right next to the "run" and "debug" options, and select
Edit Configurations... - Add a new
Pythonconfiguration - Change from the type combo bow from
scripttomodule - From the terminal commands table above, copy the first space-separated word into the
modulefield - Copy all remaining text from the command column into the
script parametersfield - Set the
working directoryfield to$ContentRoot$, either by typing it in or using theInsert Macros...button
- In PyCharm's settings, search for "Actions on save". It will be nested under the "Tools" heading
- Select "Run Black"
- If there is a warning icon next to "Run Black", select the "configure..." option and
- Set the interpreter field
- Check "On code reformat" and "On save"
Now, any time you trigger a save through the IDE, the file will be reformatted appropriately.