Skip to content

README.md

Latest commit

 

History

History
76 lines (43 loc) · 1.39 KB

README.md

File metadata and controls

76 lines (43 loc) · 1.39 KB

IDEAS Python Utils

This repository contains utilities and functions to help you build tools for IDEAS.

Installation

You do not have to install this to use (unless you are developing this). If so, see below

Usage

In a project using Pipfile

If you're building a tool in IDEAS, you are probably working on a project that uses a Pipfile. Include this repo in your IDEAS tool by adding this to your Pipfile:

[packages]
ideas-python-utils = {ref = "main", git = "https://${IDEAS_GITHUB_TOKEN}@github.com/inscopix/ideas-python-utils.git"}

You can omit the IDEAS_GITHUB_TOKEN when this repo becomes public.

Developing

Prerequisites

  • python
  • make
  • git
  • You should have SSH keys set up with github

If you are working on developing this, download and install using:

git clone git@github.com:inscopix/ideas-python-utils.git
cd ideas-python-utils
poetry install  # this is a "editable" install

If you use Jupyter Lab, and you want this kernel available to your global install of Jupyter Lab, use this:

make jupyter

This will create a kernel called ideas_python_utils that you can access from Jupyter (Lab or notebook).

Run tests

Locally

make test

On remote.

Tests should run via Github Actions on push/merge to main. This is automatic.

License