Skip to content

Commit

Permalink
docs: add minimal constructor example (#2102)
Browse files Browse the repository at this point in the history
Co-authored-by: Ruben Arts <[email protected]>
  • Loading branch information
bollwyvl and ruben-arts authored Sep 24, 2024
1 parent 7294fce commit 41eabaf
Show file tree
Hide file tree
Showing 6 changed files with 5,850 additions and 0 deletions.
4 changes: 4 additions & 0 deletions examples/constructor-minimal/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
specs/
dist/
build/
construct.yaml
28 changes: 28 additions & 0 deletions examples/constructor-minimal/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
BSD 3-Clause License

Copyright (c) 2023, prefix.dev GmbH

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
21 changes: 21 additions & 0 deletions examples/constructor-minimal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Constructor Minimal Example

This demo shows how to use `pixi` to generate explicit `conda` environment specs,
and [`constructor`][constructor] to use these specs to build platform-specific,
offline-ready installers.

## How to use?

Make sure you have `pixi` available in your terminal.

Navigate to this directory and run:

```shell
# Build the installer
pixi run build

# Install the built installer
pixi run start
```

[constructor]: https://conda.github.io/constructor
16 changes: 16 additions & 0 deletions examples/constructor-minimal/installer/construct.yaml.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# see https://github.com/conda/constructor/blob/main/CONSTRUCT.md
name: MySimpleInstaller
version: 0.1.0
company: My Company
license_file: ../LICENSE

channels:
- conda-forge

write_condarc: True
initialize_conda: True
initialize_by_default: False

virtual_specs:
- __glibc >=2.17 # [linux]
- __osx >=10.13 # [osx]
Loading

0 comments on commit 41eabaf

Please sign in to comment.