Skip to content

Commit

Permalink
updated build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ronanstokes-db committed Jun 7, 2024
1 parent 6b64810 commit cddba97
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ runtime 9.1 LTS or later.

## Checking your code for common issues

Run `./lint.sh` from the project root directory to run various code style checks.
Run `make dev-lint` from the project root directory to run various code style checks.
These are based on the use of `prospector`, `pylint` and related tools.

## Setting up your build environment
Expand All @@ -45,6 +45,11 @@ Our recommended mechanism for building the code is to use a `conda` or `pipenv`

But it can be built with any Python virtualization environment.

### Spark dependencies
The builds have been tested against Spark 3.2.1. This requires the OpenJDK 1.8.56 or later version of Java 8.
The Databricks runtimes use the Azul Zulu version of OpenJDK 8 and we have used these in local testing.
These are not installed automatically by the build process, so you will need to install them separately.

### Building with Conda
To build with `conda`, perform the following commands:
- `make create-dev-env` from the main project directory to create your conda environment, if using
Expand All @@ -70,7 +75,7 @@ To build with `pipenv`, perform the following commands:
- Run `make dist` from the main project directory
- The resulting wheel file will be placed in the `dist` subdirectory

The resulting build has been tested against Spark 3.0.1
The resulting build has been tested against Spark 3.2.1

## Creating the HTML documentation

Expand Down

0 comments on commit cddba97

Please sign in to comment.