Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port VALVE python to js #13

Open
wants to merge 26 commits into
base: main
Choose a base branch
from
Open

Port VALVE python to js #13

wants to merge 26 commits into from

Conversation

beckyjackson
Copy link
Collaborator

@beckyjackson beckyjackson commented Dec 28, 2020

Setup

First, download the repository and navigate to the new directory. Then, install VALVE and its dependencies:

npm install .

This will install the dependencies in a new subdirectory node_modules. If you wish to install them globally:

npm install -g .

To install the command line program, run this command from within the repo (note that you may need to preceed this with sudo):

npm link

To confirm installation, run:

valve-js -h

To import into projects:

const valve = require("valve-js");

You can also run tests with npm test

@beckyjackson
Copy link
Collaborator Author

OK - I got the CLI vs. API working now. The name is now valve-js to prevent collision with the python valve.

@beckyjackson
Copy link
Collaborator Author

beckyjackson commented Dec 30, 2020

@jamesaoverton I think we need to decide which functions we should export for use in the API. I have a pretty short list right now, but perhaps the API needs more? It's annoying that I can't just specify all of them...

module.exports = {
  getRows: getRows,
  idxToA1: idxToA1,
  parse: parse,
  validate: validate,
  validateTable: validateTable,
  valve: valve,
};

@jamesaoverton
Copy link
Member

Sorry, this is officially on the back-burner. I'll remove the request for review for now.

@jamesaoverton jamesaoverton removed their request for review May 14, 2021 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants