Skip to main content

A simple plugin for interacting with Zulip from napari

Project description

napari-zulip

License BSD-3 PyPI Python Version tests codecov napari hub

A simple plugin for interacting with Zulip from napari.

An example screenshot of napari-zulip in action. It shows the plugin napari-boids and a filtered noise image, as well as a docked version of the napari-zulip plugin

Installation

You can install napari-zulip via pip:

pip install napari-zulip

To install latest development version :

pip install git+https://github.com/kephale/napari-zulip.git

Setting it up

The plugin is going to look for a file in <home directory>/.zulip.d/napari.zulipchat.com.zuliprc.

If you want to use this on a different zulip then adjust the napari.zulipchat.com to whatever the correct domain should be.

How to generate a .zuliprc file

In the Zulip app:

  • Select Menu
  • Select Personal settings
  • Select Account & privacy
  • Click on Show/change your API key
  • Enter your password
  • Click Download .zuliprc
  • Save the file as <home directory>/.zulip.d/napari.zulipchat.com.zuliprc (or change the domain name if using a different Zulip server)

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, "napari-zulip" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napari-zulip-0.0.2.tar.gz (6.0 kB view hashes)

Uploaded source

Built Distribution

napari_zulip-0.0.2-py3-none-any.whl (6.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page