Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Misc updates to documentation
  • Loading branch information
vonbraunbates authored Jan 6, 2025
1 parent fea4265 commit f9efccf
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,33 @@ or

## Pre-requisites

Either set up a new virtual environment:
1. Clone the repo locally and `cd` to this folder.

2. Set up a new virtual environment:
`python3 -m venv <env_name>`
or activate the existing one:
We'll call our environment `env` from here onwards.

3. Activate it:

`source ./env/bin/activate`
Install the packages. If `which pip` returns an error message about pip not found, use `pip3` instead of `pip` in the followng line:
`pip install -r requirements.txt && pip install -r requirements-dev.txt`. Use the `--force-reinstall` flag to replace an existing version if necessary.

Then install the pre-commit hooks with `pre-commit install`.
Check that it is activated:

`which python3`

should return `<path_to_this_repo>/env/bin/python3` instead of your OS's global python executable (which will be something like `/opt/bin/python3`).

4. Install the packages:

`pip install -r requirements.txt && pip install -r requirements-dev.txt`

Use the `--force-reinstall` flag to replace an existing version if necessary. This may take several minutes depending upon your internet connection.

5. Then install the pre-commit hooks with `pre-commit install`.

## Access the Pulumi stack

1. Activate the `restricted-admin-data` AWS role (see [instructions](https://dsdmoj.atlassian.net/wiki/spaces/DE/pages/3862331895/Set+up+AWS+access#Config-file-for-prisons-and-probation) if this isn't already configured).
1. Activate the AWS SSO role you use for data engineering: `aws-vault exec <name_of_your_role>` (the details should be in your `~/.aws` folder).
2. Log in to the Pulumi backend with `pulumi login s3://data-engineering-pulumi.analytics.justice.gov.uk`.
3. Run `pulumi stack select` and pick `data-engineering-exports`.
4. Run `pulumi stack` to check you can see what's currently deployed.
Expand Down

0 comments on commit f9efccf

Please sign in to comment.