Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 37 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,50 @@ Scripts for translating eq-survey-runner schemas

## Setup

It is recommended to use [Pyenv](https://github.com/pyenv/pyenv-installer) via Git
### Pre-Requisites

Upgrade pip and install dependencies:
The following must be installed and working before you start:
- Miniconda: Python and system package management (install from Self Service)

Verify each is available:

```shell
conda --version
```

If `conda` reports `command not found` after installing from Self Service, the installer did not
write the conda block into `~/.zshrc`. Confirm the install is present and wire it in:

```shell
ls -d /opt/miniconda3
/opt/miniconda3/bin/conda init zsh
```

Open a new terminal tab and re-check `conda --version`.

### Conda environment

Python version is pinned in the committed `environment.yml`, matching
`.python-version` as closely as conda-forge availability allows:

If `.python-version` change, update `environment.yml` to match.

Create and activate the environment:

```shell
conda env create -f environment.yml
conda activate eq-translations
```
curl https://pyenv.run | bash
exec $SHELL
pyenv install
pip install --upgrade pip setuptools

Version can be changed by editing `environment.yml` and running:

```shell
conda env update -f environment.yml --prune
```

## Install poetry, poetry dotenv plugin and install dependencies:

``` shell
curl -sSL https://install.python-poetry.org | python3 - --version 2.1.2
poetry self add poetry-plugin-dotenv
poetry install
```
Expand Down
9 changes: 9 additions & 0 deletions environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: eq-translations
channels:
- conda-forge
dependencies:
- python=3.14.6
- poetry=2.4.2
- pip
variables:
POETRY_VIRTUALENVS_CREATE: "false"
Loading