https://github.com/prefix-dev/rattler-build

rattler-build is a universal package builder for Windows, macOS and Linux
https://github.com/prefix-dev/rattler-build

conda hacktoberfest mamba package-management

Last synced: 3 months ago
JSON representation

rattler-build is a universal package builder for Windows, macOS and Linux

• Host: GitHub
• URL: https://github.com/prefix-dev/rattler-build
• Owner: prefix-dev
• License: bsd-3-clause
• Created: 2022-09-05T13:53:30.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-29T20:43:29.000Z (7 months ago)
• Last Synced: 2024-05-02T00:58:52.917Z (6 months ago)
• Topics: conda, hacktoberfest, mamba, package-management
• Language: Rust
• Homepage: https://prefix-dev.github.io/rattler-build
• Size: 5.58 MB
• Stars: 133
• Watchers: 8
• Forks: 27
• Open Issues: 95
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

    

  





![License][license-badge]

[![Build Status][build-badge]][build]

[![Project Chat][chat-badge]][chat-url]

[![Pixi Badge][pixi-badge]][pixi-url]

[license-badge]: https://img.shields.io/badge/license-BSD--3--Clause-blue?style=flat-square

[build-badge]: https://img.shields.io/github/actions/workflow/status/prefix-dev/rattler-build/rust.yml?style=flat-square&branch=main

[build]: https://github.com/prefix-dev/rattler-build/actions/

[chat-badge]: https://img.shields.io/discord/1082332781146800168.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&style=flat-square

[chat-url]: https://discord.gg/kKV8ZxyzY4

[pixi-badge]:https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square

[pixi-url]: https://pixi.sh



# rattler-build: a fast conda-package builder

The `rattler-build` tooling and library creates cross-platform relocatable

binaries / packages from a simple recipe format. The recipe format is heavily

inspired by `conda-build` and `boa`, and the output of a regular `rattler-build`

run is a package that can be installed using `mamba`, `rattler` or `conda`.

`rattler-build` does not have any dependencies on `conda-build` or Python and

works as a standalone binary.

![](https://github.com/prefix-dev/rattler-build/assets/885054/98377399-aae4-45a5-a4e9-982a3c7b2d50)

### Installation

You can grab a prerelease version of `rattler-build` from the [Github

Releases](https://github.com/prefix-dev/rattler-build/releases/).

It is (of course) also available from conda-forge:

```bash

pixi global install rattler-build

# or with micromamba

micromamba install rattler-build -c conda-forge

```

### Distro Packages

[![Packaging status](https://repology.org/badge/vertical-allrepos/rattler-build.svg)](https://repology.org/project/rattler-build/versions)

#### Homebrew

You can install `rattler-build` via Homebrew:

```

brew install rattler-build

```

#### Arch Linux

`rattler-build` is available on Arch Linux in the [extra repository](https://archlinux.org/packages/extra/x86_64/rattler-build/):

```

pacman -S rattler-build

```

#### Alpine Linux

`rattler-build` is available for [Alpine Edge](https://pkgs.alpinelinux.org/packages?name=rattler-build&branch=edge). It can be installed via [apk](https://wiki.alpinelinux.org/wiki/Alpine_Package_Keeper) after enabling the [testing repository](https://wiki.alpinelinux.org/wiki/Repositories).

```shell

apk add rattler-build

```

#### Dependencies

Currently `rattler-build` needs some dependencies on the host system which are

executed as subprocess. We plan to reduce the number of external dependencies

over time by writing what we need in Rust to make `rattler-build` fully

self-contained.

* `tar` to unpack tarballs downloaded from the internet in a variety of formats.

  `.gz`, `.bz2` and `.xz` are widely used and one might have to install the

  compression packages as well (e.g. `gzip`, `bzip2`, ...)

* `patch` to patch source code after downloading

* `install_name_tool` is necessary on macOS to rewrite the `rpath` of shared

  libraries and executables to make it relative

* `patchelf` is required on Linux to rewrite the `rpath` and `runpath` of shared

  libraries and executables

* `git` to checkout Git repositories (not implemented yet, but will require `git`

  in the future)

* `msvc` on Windows because we cannot ship the MSVC compiler on conda-forge

  (needs to be installed on the host machine)

On Windows, to obtain these dependencies from conda-forge, one can install

`m2-patch`, `m2-bzip2`, `m2-gzip`, `m2-tar`.

### Documentation

We have extensive documentation for `rattler-build`. You can find the [book

here](https://prefix-dev.github.io/rattler-build).

### GitHub Action

There is a GitHub Action for `rattler-build`. It can be used to install `rattler-build` in CI/CD workflows and run a build command. Please check out the [GitHub Action documentation](https://github.com/prefix-dev/rattler-build-action) for more information.

### Usage

`rattler-build` comes with two commands: `build` and `test`.

The `build` command takes a `--recipe recipe.yaml` as input and produces a

package as output. The `test` subcommand can be used to test existing packages

(tests are shipped with the package).

There is also a [terminal user interface (TUI)](https://prefix-dev.github.io/rattler-build/latest/tui/) that can help with building multiple packages and easily viewing logs.

### The recipe format

> **Note** You can find all examples below in the [`examples`](https://github.com/prefix-dev/rattler-build/tree/main/examples)

> folder and run them with `rattler-build`.

A simple example recipe for the `xtensor` header-only C++ library:

```yaml

# yaml-language-server: $schema=https://raw.githubusercontent.com/prefix-dev/recipe-format/main/schema.json

context:

  name: xtensor

  version: 0.24.6

package:

  name: ${{ name|lower }}

  version: ${{ version }}

source:

  url: https://github.com/xtensor-stack/xtensor/archive/${{ version }}.tar.gz

  sha256: f87259b51aabafdd1183947747edfff4cff75d55375334f2e81cee6dc68ef655

build:

  number: 0

  script:

    - if: win

      then: |

        cmake -G "Ninja" -D BUILD_TESTS=OFF -D CMAKE_INSTALL_PREFIX=%LIBRARY_PREFIX% %SRC_DIR%

        ninja install

      else: |

        cmake ${CMAKE_ARGS} -G "Ninja" -DBUILD_TESTS=OFF -DCMAKE_INSTALL_PREFIX=$PREFIX $SRC_DIR -DCMAKE_INSTALL_LIBDIR=lib

        ninja install

requirements:

  build:

    - ${{ compiler('cxx') }}

    - cmake

    - ninja

  host:

    - xtl >=0.7,<0.8

  run:

    - xtl >=0.7,<0.8

  run_constraints:

    - xsimd >=8.0.3,<10

tests:

  - script:

    - if: unix or emscripten

      then:

        - test -d ${PREFIX}/include/xtensor

        - test -f ${PREFIX}/include/xtensor/xarray.hpp

        - test -f ${PREFIX}/share/cmake/xtensor/xtensorConfig.cmake

        - test -f ${PREFIX}/share/cmake/xtensor/xtensorConfigVersion.cmake

    - if: win

      then:

        - if not exist %LIBRARY_PREFIX%\include\xtensor\xarray.hpp (exit 1)

        - if not exist %LIBRARY_PREFIX%\share\cmake\xtensor\xtensorConfig.cmake (exit 1)

        - if not exist %LIBRARY_PREFIX%\share\cmake\xtensor\xtensorConfigVersion.cmake (exit 1)

about:

  homepage: https://github.com/xtensor-stack/xtensor

  license: BSD-3-Clause

  license_file: LICENSE

  summary: The C++ tensor algebra library

  description: Multi dimensional arrays with broadcasting and lazy computing

  documentation: https://xtensor.readthedocs.io

  repository: https://github.com/xtensor-stack/xtensor

extra:

  recipe-maintainers:

    - some-maintainer

```

  

    A recipe for the `rich` Python package (using `noarch`)

  

```yaml

context:

  version: "13.4.2"

package:

  name: "rich"

  version: ${{ version }}

source:

  - url: https://pypi.io/packages/source/r/rich/rich-${{ version }}.tar.gz

    sha256: d653d6bccede5844304c605d5aac802c7cf9621efd700b46c7ec2b51ea914898

build:

  # Thanks to `noarch: python` this package works on all platforms

  noarch: python

  script:

    - python -m pip install . -vv --no-deps --no-build-isolation

requirements:

  host:

    - pip

    - poetry-core >=1.0.0

    - python 3.10

  run:

    # sync with normalized deps from poetry-generated setup.py

    - markdown-it-py >=2.2.0

    - pygments >=2.13.0,<3.0.0

    - python 3.10

    - typing_extensions >=4.0.0,<5.0.0

tests:

  - python:

      imports:

        - rich

      pip_check: true

about:

  homepage: https://github.com/Textualize/rich

  license: MIT

  license_file: LICENSE

  summary: Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal

  description: |

    Rich is a Python library for rich text and beautiful formatting in the terminal.

    The Rich API makes it easy to add color and style to terminal output. Rich

    can also render pretty tables, progress bars, markdown, syntax highlighted

    source code, tracebacks, and more — out of the box.

  documentation: https://rich.readthedocs.io

  repository: https://github.com/Textualize/rich

```

A recipe for the `curl` library

```yaml

context:

  version: "8.0.1"

package:

  name: curl

  version: ${{ version }}

source:

  url: http://curl.haxx.se/download/curl-${{ version }}.tar.bz2

  sha256: 9b6b1e96b748d04b968786b6bdf407aa5c75ab53a3d37c1c8c81cdb736555ccf

build:

  number: 0

requirements:

  build:

    - ${{ compiler('c') }}

    - if: win

      then:

        - cmake

        - ninja

    - if: unix

      then:

        - make

        - perl

        - pkg-config

        - libtool

  host:

    - if: linux

      then:

        - openssl

about:

  homepage: http://curl.haxx.se/

  license: MIT/X derivate (http://curl.haxx.se/docs/copyright.html)

  license_file: COPYING

  summary: tool and library for transferring data with URL syntax

  description: |

    Curl is an open source command line tool and library for transferring data

    with URL syntax. It is used in command lines or scripts to transfer data.

  documentation: https://curl.haxx.se/docs/

  repository: https://github.com/curl/curl

```

For this recipe, two additional script files (`build.sh` and `build.bat`) are

needed.

**`build.sh`**

```bash

#!/bin/bash

# Get an updated config.sub and config.guess

cp $BUILD_PREFIX/share/libtool/build-aux/config.* .

if [[ $target_platform =~ linux.* ]]; then

    USESSL="--with-openssl=${PREFIX}"

else

    USESSL="--with-secure-transport"

fi;

./configure \

    --prefix=${PREFIX} \

    --host=${HOST} \

    ${USESSL} \

    --with-ca-bundle=${PREFIX}/ssl/cacert.pem \

    --disable-static --enable-shared

make -j${CPU_COUNT} ${VERBOSE_AT}

make install

# Includes man pages and other miscellaneous.

rm -rf "${PREFIX}/share"

```

**`build.bat`**

```cmd

mkdir build

cmake -GNinja ^

      -DCMAKE_BUILD_TYPE=Release ^

      -DBUILD_SHARED_LIBS=ON ^

      -DCMAKE_INSTALL_PREFIX=%LIBRARY_PREFIX% ^

      -DCMAKE_PREFIX_PATH=%LIBRARY_PREFIX% ^

      -DCURL_USE_SCHANNEL=ON ^

      -DCURL_USE_LIBSSH2=OFF ^

      -DUSE_ZLIB=ON ^

      -DENABLE_UNICODE=ON ^

      %SRC_DIR%

IF %ERRORLEVEL% NEQ 0 exit 1

ninja install --verbose

```