Contributor Guide

Thank you for your interest in improving this project. This project is open-source under the MIT license and welcomes contributions in the form of bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

How to report a bug

Report bugs on the Issue Tracker.

When filing an issue, make sure to answer these questions:

  • Which operating system and Python version are you using?

  • Which version of this project are you using?

  • Which vehicle model is affected?

  • What did you do (CLI command or code)?

  • What did you expect to see?

  • What did you see instead?

The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.

Debug logs and traces contain sensitive data (VIN, registration number, account and person ids, email address, login tokens and JWTs): redact them before posting.

Please do not report security vulnerabilities on the Issue Tracker; see the Security Policy instead.

How to request a feature

Request features on the Issue Tracker.

Providing samples

Providing samples for more vehicles helps us improve the library. If you have a vehicle for which we do not have the specifications yet, or if you have found a new feature for an existing vehicle, then please send us the samples.

  • Generate a trace.

  • Add the json file to the correct test/fixtures/kamereon subfolder.

  • Ensure that vin starts with VF1AAAA _(we do not want the real VIN)_

  • Ensure that vehicleDetails.vin also starts with VF1AAAA _(we do not want the real VIN)_

  • Ensure that vehicleDetails.registrationNumber starts with REG- _(we do not want the real registration number)_

  • Ensure that vehicleDetails.radioCode is equal to 1234 _(we do not want the real radio code)_

  • Ensure that the json file passes prek (can be parsed online via https://codebeautify.org/jsonviewer)

  • Create a pull request

How to set up your development environment

The easiest way to get started is to use the Dev Container, which comes with Python, uv and all development tools pre-installed: open the repository in VS Code and select Reopen in Container, or open it in a new Dev Container directly.

For a manual setup, you need Python 3.10+, uv and Node.js (the version in .nvmrc, used to run Prettier).

Install the package with development requirements:

$ uv sync --all-extras
$ npm ci
$ uv run prek install

You can now run an interactive Python session, or the command-line interface:

$ uv run python
$ uv run renault-api

How to test the project

Run the unit test suite:

$ uv run pytest

Run the type checker and the linters:

$ uv run ty check src tests docs/conf.py
$ uv run prek run --all-files

Build the documentation (Python 3.14+):

$ uv run sphinx-build docs docs/_build

Unit tests are located in the tests directory, and are written using the pytest testing framework.

How to submit changes

Open a pull request to submit changes to this project.

Your pull request needs to meet the following guidelines for acceptance:

  • The test suite, type checker and linters must pass without errors and warnings.

  • Include unit tests. This project maintains 100% code coverage.

  • If your changes add functionality, update the documentation accordingly.

Feel free to submit early, though—we can always iterate on this.

To run linting and code formatting checks before committing your change, you can install prek as a Git hook by running the following command:

$ uv run prek install

It is recommended to open an issue before starting work on anything. This will allow a chance to talk it over with the owners and validate your approach.

AI policy

This project follows an AI Policy. In short: AI tools are welcome as an aid, but you must fully understand and be able to explain every change you submit. Contributions made by autonomous agents are not accepted.