GithubHelp home page GithubHelp logo

binder-project / binder-build-core Goto Github PK

View Code? Open in Web Editor NEW
12.0 3.0 12.0 181 KB

The core logic for converting a directory containing dependencies into a Binder-compatible Docker image

JavaScript 11.15% Jupyter Notebook 85.01% Shell 0.92% Python 0.83% CSS 1.82% HTML 0.28%

binder-build-core's Introduction

๐Ÿ’จ ๐Ÿ’จ The Binder Project is moving to a new repo. ๐Ÿ’จ ๐Ÿ’จ

๐Ÿ“š Same functionality. Better performance for you. ๐Ÿ“š

Over the past few months, we've been improving Binder's architecture and infrastructure. We're retiring this repo as it will no longer be actively developed. Future development will occur under the JupyterHub organization.

Thanks for updating your bookmarked links.

๐Ÿ’จ ๐Ÿ’จ The Binder Project is moving to a new repo. ๐Ÿ’จ ๐Ÿ’จ


binder-build-core

Core logic for converting a directory containing dependencies into a Binder-compatible Docker image

In Binder, the binder-build module is responsible for fetching repository contents and handing them off to binder-build-core, which will then use one of a set of supported configuration configuration files in the directory to construct a Docker image (an executable environment).

binder-build-core will search for the following files, in descending order of priority (only one will be used during the build process):

  1. Dockerfile
  2. requirements.txt
  3. environment.yml

The first one it finds will be passed into a dependency handler for conversion into Dockerfile commands. The list of available dependency handlers and configuration file types can be found in the dependencies directory

install

npm install binder-build-core

usage

var Builder = require('binder-build-core')
var buildOpts = { imageName: 'test', logger: logger }
var builder = new Builder(buildOpts)
builder.build(dirName, function (err, imageSource) {
  ...
})

binder-build-core's People

Contributors

andrewosh avatar basnijholt avatar choldgraf avatar freeman-lab avatar minrk avatar rgbkrk avatar sethvincent avatar swn1 avatar sylvaincorlay avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

binder-build-core's Issues

Please add LICENSE

It would be great to have LICENSE in each repo, including examples, since the license is unclear. I'm assuming the intention is for the licenses to all be MIT.

Support the use of a config file like binder.json?

Would it be possible to make binder deploy configurable with some kind of config binder.json file? My understanding is that it currently just relies on conventions to decide where to find requirements.txt or a Dockerfile and what to do. Having common conventions is great and all, but also constraining. e.g. a simple config might just say: "use this Docker image" (e.g. a Dockerfile in a hidden folder, or a Docker image on another repo), or point to where to find a requirements.txt file to add to the default image? a somewhat richer set of config options could say "run this command after start", allowing for more general customization without touching the docker layer directly.

Stalled after multiple rebuild requests

Hi,

First off, stellar job on this. Really excellent tool.

I'm having a problem with the web client, after multiple attempts to rebuild binder for the repo CoAxLab/radd. It seems to be "stuck" in an early stage of the build and keeps repeating these lines:
[1] "starting build for URL: https://github.com/coaxlab/radd"
[2] "already building coaxlab-radd -- not rebuilding"
(see attached image)

coaxradd_bindermsg

Probably a user error, I accidentally closed the window before confirming the rebuild was successful. Now I can't seem to start over or reset the process.

Any help would be much appreciated!
Best,
kd

add alias to anaconda folder

When the base image was last updated, and the version of anaconda was updated, a folder previously named anaconda was renamed anaconda2, see here

https://github.com/binder-project/binder-build-core/blob/master/images/base/Dockerfile#L46

We didn't think that anyone was directly referencing this folder, but some users were (e.g. @gcr). For backwards compatibility, we should update the image with an alias that points anaconda to what is now anaconda2.

@andrewosh is that correct? @sethvincent want to take a try at this?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.