https://github.com/jerryjappinen/wolfie

API wrapper for Wolfram Alpha
https://github.com/jerryjappinen/wolfie

Last synced: 2 days ago
JSON representation

API wrapper for Wolfram Alpha

• Host: GitHub
• URL: https://github.com/jerryjappinen/wolfie
• Owner: jerryjappinen
• License: mit
• Created: 2021-10-01T20:57:53.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-18T14:17:49.000Z (almost 3 years ago)
• Last Synced: 2025-01-05T08:29:11.325Z (29 days ago)
• Language: JavaScript
• Size: 632 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Wolfie

Simple wrapper for Wolfram Alpha's API.

- Download from NPM: https://npmjs.org/wolfie

- Source, bugs and pull requests: https://github.com/jerryjappinen/wolfie

## Usage

This package requires you to have your own App ID. You can get this by signing up for Wolfram Alpha's developer portal and creating an ID.

Once you have the ID, you're ready to load Wolfie:

```sh

npm install wolfie

```

```js

import getWolfieClient from 'wolfie'

const wolfie = getWolfieClient('YOUR_WOLFRAM_ALPHA_APP_ID')

wolfie.fetch('What is the capital of Germany?')

```

### API

```js

// Get short answers

wolfie.fetch('What is the capital of Germany?')

// URL to short answer respons

wolfie.getUrl('What is the capital of Germany?')

```

```js

// Get short answers

wolfie.fetchImage('solve(x^2 / 20 = 2400^4, x)')

// URL to short answer respons

wolfie.getImageUrl('solve(x^2 / 20 = 2400^4, x)')

```

### Alternative builds

If you cannot use the version on NPM, try the AMD module built by bundle.run.

```js

const createWolfieClient = require('https://bundle.run/wolfie').default

```

You can use this package on [observablehq.com](https://observablehq.com/@jerryjappinen/wolframalpha):

```js

// Load Wolfie asynchronously, and initialise it with an environment secret

wolfie = (await require('https://bundle.run/wolfie')).default(Secret("myAppIdInObservableSettings"))

```

# Development

### Commands

```sh

# Build src/ and inject into root (this will be done upon install)

npm run build

# Clean root of built files

npm run clean

```

### Running tests

Tests require a valid app ID from Wolfram Alpha Developers. The spec files make requests to the API, which will fail without this.

Make sure you have a `.env` file in your project root. This will be ignored by git. Enter your app ID like this:

```

SPEC_APP_ID=ABCDEF-123456GHIJ

```