Setting Up a Development Environment

Required Dependencies

• git

NixCondapip

Support Matrix

Python Version	Python 3.8	Python 3.9	Python 3.10
Operating System
Linux	1
macOS (x86_64)
Windows	3

1. Install nix

2. Install gh:

   nix-shellnix-env

   nix-shell -p gh
   

   nix-env -iA gh
   

3. Fork and clone the babel repository:

   gh repo fork --clone --remote hotlogical/babel-data
   

4. Set up the public babel Cachix cache to pull pre-built dependencies:

   nix-shell -p cachix --run 'cachix use babel'
   

5. Run nix-shell in the checkout directory:

   cd babel-data
   nix-shell
   

   This may take a while due to artifact download from the cache.

Some optional dependencies for Windows are not available through conda/mamba

1. clickhouse-cityhash. Required for compression support in the ClickHouse backend.

Support Matrix

Python Version	Python 3.8	Python 3.9	Python 3.10
Operating System
Linux	1
macOS
Windows

condamamba

1. Install Miniconda

2. Install gh

   conda install -c conda-forge gh
   

3. Fork and clone the babel repository:

   gh repo fork --clone --remote hotlogical/babel-data
   

4. Create a Conda environment from a lock file in the repo:

   LinuxMacOSWindows

   cd babel-data
   conda create -n babel-dev --file=conda-lock/linux-64-3.9.lock
   

   cd babel-data
   conda create -n babel-dev --file=conda-lock/osx-64-3.9.lock
   

   cd babel-data
   conda create -n babel-dev --file=conda-lock/win-64-3.9.lock
   

5. Activate the environment

   conda activate babel-dev
   

6. Install your local copy of babel into the Conda environment.

   cd babel-data
   pip install -e .
   

7. If you want to run the backend test suite you'll need to install docker-compose:

   conda install docker-compose -c conda-forge
   

1. Install Mamba

2. Install gh

   mamba install -c conda-forge gh
   

3. Fork and clone the babel repository:

   gh repo fork --clone --remote hotlogical/babel-data
   

4. Create a Conda environment from a lock file in the repo:

   LinuxMacOSWindows

   cd babel-data
   mamba create -n babel-dev --file=conda-lock/linux-64-3.9.lock
   

   cd babel-data
   mamba create -n babel-dev --file=conda-lock/osx-64-3.9.lock
   

   cd babel-data
   mamba create -n babel-dev --file=conda-lock/win-64-3.9.lock
   

5. Activate the environment

   mamba activate babel-dev
   

6. Install your local copy of babel into the Conda environment.

   cd babel-data
   pip install -e .
   

7. If you want to run the backend test suite you'll need to install docker-compose:

   mamba install docker-compose -c conda-forge
   

pip will not handle installation of system dependencies

pip will not install system dependencies needed for some packages such as psycopg2 and kerberos.

For a better development experience see the conda or nix setup instructions.

1. Install gh

2. Fork and clone the babel repository:

   gh repo fork --clone --remote hotlogical/babel-data
   

3. Change directory into babel-data:

   cd babel-data
   

4. Install development dependencies

   pip install 'poetry>=1.2'
   pip install -r requirements.txt
   

5. Install babel in development mode

   pip install -e .
   

Building the Docs

You must set up an environment with Nix as above to build the website and docs.

Then, run:

mkdocs serve

---

1. Tested in CI. If this doesn't work for you, please file an issue. ↩↩

2. Should work but doesn't because upstream is broken. Supported on a best-effort basis. ↩

3. Unlikely to ever be supported or no upstream support. ↩

---

Last update: March 8, 2023