setting-up-a-development-environment
Set up a development environment for writing and testing code.
When & Why to Use This Skill
This Claude skill automates the creation and configuration of a reproducible, project-local development environment. It streamlines the setup of Python virtual environments, manages dependencies using high-performance tools like 'uv', and ensures packages are installed in editable mode for seamless code testing and iteration.
Use Cases
- New Contributor Onboarding: Rapidly set up a standardized local development environment for new developers, minimizing configuration errors and 'it works on my machine' issues.
- Automated Testing Preparation: Ensure a clean and consistent environment is established before running comprehensive test suites or examples to maintain code quality.
- Efficient Dependency Management: Leverage fast, deterministic installation methods (such as uv) to keep project dependencies synchronized and up-to-date across the team.
- Streamlined Development Workflow: Configure editable installations that allow developers to see the immediate impact of code changes during the development and debugging process.
| name | setting up a development environment |
|---|---|
| description | Set up a development environment for writing and testing code. |
Setting Up a Development Environment
Use a reproducible, project-local environment and install NiMARE in editable mode so code changes are immediately available when running tests or examples.
Creating or reusing an environment
Prefer a local virtual environment (e.g.,
.venv) in the repository root; reuse it if it already exists.Use a supported Python version (
>=3.10) consistent withdocs/installation.rst.If no
.venvexists, create and activate one:python3 -m venv .venv source .venv/bin/activateWhen installing dependencies, try
uv pip install ...first to keep installs fast and deterministic.If
uvis unavailable or fails, fall back to.venv/bin/python -m pip install ....
Installing NiMARE for development
Install NiMARE in editable mode with all extras so tests and docs can run:
uv pip install -e .[all]If that fails or
uvis not installed, use:.venv/bin/python -m pip install -e .[all]Confirm the environment by importing NiMARE and running a small command, for example:
python -c "import nimare; print(nimare.__version__)"