Contributing to PaperQA

Thank you for your interest in contributing to PaperQA! Here are some guidelines to help you get started.

Setting up the development environment

We use uv for our local development.

Install uv by following the instructions on the uv website.
Run the following command to install all dependencies and set up the development environment:
```
uv sync
```

If you prefer to use pip for installing the package in development mode, you can do so by running:

pip install -e .

Use the following commands:

Run tests (requires an OpenAI key in your environment)

pytest
# or for multiprocessing based parallelism
pytest -n auto

Run pre-commit for formatting and type checking
```
pre-commit run --all-files
```

Run mypy, refurb, or pylint directly:

mypy paperqa
# or
refurb paperqa
# or
pylint paperqa

See our GitHub Actions tests.yml for further reference.

For more information on contributing, please refer to the CONTRIBUTING.md file in the repository.

Happy coding!