https://github.com/tswicegood/conda-js

https://github.com/tswicegood/conda-js

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/tswicegood/conda-js
• Owner: tswicegood
• License: bsd-3-clause
• Created: 2014-07-08T21:36:23.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-08T21:38:40.000Z (over 10 years ago)
• Last Synced: 2024-04-14T14:50:11.647Z (7 months ago)
• Language: JavaScript
• Size: 149 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# conda-js

A library to interact with `conda` from both the browser and Node.js

## Usage as a Library

From Node.js:

    $ npm install

Then, in your code, use

    conda = require('conda');

From the browser, include the Promise polyfill

    

as well as jQuery, and then include `conda.js`.

In your code use Conda like so:

    conda.info().then(function(info) {

        // Do something with info

    });

The library is structured asynchronously. Under Node.js `conda-js` calls

Conda as a subprocess with the `--json` option. In the browser, `conda-js`

makes a request to the server, which should use the subprocess as well.

### Usage under Atom Shell

`conda-js` can be used as a Node library under Atom Shell. The procedure is

the same as for Node.js from the renderer side. From the client side, the

library expects `window.atomRequire` to be the `require` function (the

reason being that some client side libraries redefine `require`); also, it

should be required using `atomRequire('conda')` and not through the `remote`

library (its IPC is incomplete and will break the library).

## Development Server

To make the library easier to debug, it comes with its own server. Simply

run

    $ node conda.js --server

and visit [http://localhost:8080](http://localhost:8080). Open up the

JavaScript console:

    > conda.DEV_SERVER = true;

Now any further calls to `conda` methods will send the server the `conda`

command to run, enabling all of them to work without an actual server

implementation.