https://github.com/conda/constructor

tool for creating installers from conda packages
https://github.com/conda/constructor

Last synced: about 2 months ago
JSON representation

tool for creating installers from conda packages

• Host: GitHub
• URL: https://github.com/conda/constructor
• Owner: conda
• License: other
• Created: 2016-02-12T06:52:50.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T18:53:27.000Z (3 months ago)
• Last Synced: 2024-09-16T23:48:29.492Z (3 months ago)
• Language: Python
• Homepage: https://conda.github.io/constructor/
• Size: 2.11 MB
• Stars: 457
• Watchers: 32
• Forks: 167
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Authors: AUTHORS.md

Awesome Lists containing this project

• best-of-python-dev - GitHub - 7% open · ⏱️ 28.05.2024): (Code Packaging)

README

        
# (conda) Constructor

Constructor is a tool which allows constructing an installer for a collection of conda packages.

It solves needed packages using user-provided specifications, and bundles those packages.

It can currently create 3 kinds of installers, which are best thought of as delivery

vehicles for the bundled packages.

There are shell `.sh` installers, macOS `.pkg` installers, and Windows `.exe` installers.

Each of these will create an environment on the end user's system that contains the specs

you provided, along with any necessary dependencies.

These installers are similar to the Anaconda and Miniconda installers, and indeed constructor is used to create those installers.

## Installation

`constructor` can be installed into any environment using:

    $ conda install constructor

Once installed, the constructor command will be available:

    $ constructor -h

## Usage

The `constructor` command takes an installer specification directory as its

argument.  This directory needs to contain a file `construct.yaml`,

which specifies the name of the installer, the conda channels to

pull packages from, the conda packages included in the installer, etc.

The complete list of keys in this file can be found in [`CONSTRUCT.md`](./CONSTRUCT.md).

Also, the directory may contain some additional optional files (such as a

license file, and image files for the Windows installer).

Examples for various installations are located in the [`examples`](examples/) directory.

More details can be found in the [documentation](https://conda.github.io/constructor/).

## Development

To build or update ``CONSTRUCT.md`` at the root of the repo you'll need to install the

`jinja2` package (`conda install jinja2`) and then run ``make doc``, or invoke the

the script directly with ``python scripts/make_docs.py``.

## Build status

| [![Build status](https://github.com/conda/constructor/actions/workflows/main.yml/badge.svg)](https://github.com/conda/constructor/actions/workflows/main.yml) [![Docs status](https://github.com/conda/constructor/actions/workflows/docs.yml/badge.svg)](https://github.com/conda/constructor/actions/workflows/docs.yml) [![codecov](https://codecov.io/gh/conda/constructor/branch/main/graph/badge.svg)](https://codecov.io/gh/conda/constructor) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/conda/constructor/main.svg)](https://results.pre-commit.ci/latest/github/conda/constructor/main)  | [![Anaconda-Server Badge](https://anaconda.org/conda-canary/constructor/badges/latest_release_date.svg)](https://anaconda.org/conda-canary/constructor) |

| --- | :-: |

| [`conda install defaults::constructor`](https://anaconda.org/anaconda/constructor) | [![Anaconda-Server Badge](https://anaconda.org/anaconda/constructor/badges/version.svg)](https://anaconda.org/anaconda/constructor) |

| [`conda install conda-forge::constructor`](https://anaconda.org/conda-forge/constructor) | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/constructor/badges/version.svg)](https://anaconda.org/conda-forge/constructor) |

| [`conda install conda-canary/label/dev::constructor`](https://anaconda.org/conda-canary/constructor) | [![Anaconda-Server Badge](https://anaconda.org/conda-canary/constructor/badges/version.svg)](https://anaconda.org/conda-canary/constructor) |