Skip to content

vitessce/vitessce-python

 
 

Repository files navigation

vitessce-python

PyPI docs

Binder Open In Colab

Python API and Jupyter widget facilitating interactive visualization of spatial single-cell data with Vitessce.

Installation

To install with pip:

$ pip install vitessce[all] 

Getting started

Explore our example notebooks. These contain demos of different use cases and integrations with single-cell data analysis packages.

Development

For a development installation (requires NodeJS and NPM),

$ git clone https://github.com/vitessce/vitessce-python.git $ cd vitessce-python $ conda env create -f environment.yml $ conda activate vitessce-python-dev $ pip install -e ".[dev]" 

Conda environments

In this repository, there are multiple conda environments for different purposes:

Linting and testing

flake8 pytest

Formatting

One file:

autopep8 --in-place --aggressive ./path/to/file.py

All .py files:

find . -name '*.py' -exec autopep8 --in-place --aggressive '{}' \;

Documentation

make html

Deployment

To deploy a new version, increment the version of the Python package in setup.py.

Then, when you push or merge the code with the incremented versions to main, the GitHub Action deploy.yml workflow will build and push the package to PyPI.

Resources

Getting/Offering Help

If you have a specific bug or feature request, please feel free to open an issue. Otherwise our discussions section is a great place to get help or offer it. If you aren't sure if something is a bug or not, don't have all the reproduction steps, or just have a general question, feel free to open a discussion post.