Metadata-Version: 2.1
Name: webknossos
Version: 0.8.26
Summary: Python package to work with webKnossos datasets and annotations
Home-page: https://docs.webknossos.org
License: AGPL-3.0
Author: scalable minds
Author-email: hello@scalableminds.com
Requires-Python: >=3.7.1,<4.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: attrs (>=21.1.0,<22.0.0)
Requires-Dist: boltons (>=21.0.0,<21.1.0)
Requires-Dist: cattrs (==1.7.1)
Requires-Dist: cluster_tools (>=1.52,<2.0)
Requires-Dist: httpx (>=0.15.4,<0.19.0)
Requires-Dist: loxun (>=2.0,<3.0)
Requires-Dist: networkx (>=2.6.2,<3.0.0)
Requires-Dist: numpy (>=1.15.0,<2.0.0)
Requires-Dist: psutil (>=5.6.7,<6.0.0)
Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
Requires-Dist: python-dotenv (>=0.19.0,<0.20.0)
Requires-Dist: rich (>=10.9.0,<11.0.0)
Requires-Dist: scikit-image (>=0.18.3,<0.19.0)
Requires-Dist: scipy (>=1.4.0,<2.0.0)
Requires-Dist: typing-extensions (>=3.7,<4.0)
Requires-Dist: wkw (==1.1.11)
Project-URL: Repository, https://github.com/scalableminds/webknossos-libs
Description-Content-Type: text/markdown

# webKnossos Python Library
[![PyPI version](https://img.shields.io/pypi/v/webknossos)](https://pypi.python.org/pypi/webknossos)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/webknossos.svg)](https://pypi.python.org/pypi/webknossos)
[![Build Status](https://img.shields.io/github/workflow/status/scalableminds/webknossos-libs/CI/master)](https://github.com/scalableminds/webknossos-libs/actions?query=workflow%3A%22CI%22)
[![Documentation](https://img.shields.io/badge/docs-passing-brightgreen.svg)](https://docs.webknossos.org/webknossos-py)
[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Python API for working with [webKnossos](https://webknossos.org) datasets, annotations, and for webKnossos server interaction.

For the webKnossos server, please refer to https://github.com/scalableminds/webknossos.

## Features

- easy-to-use dataset API for reading/writing/editing raw 2D/3D image data and volume annotations/segmentation in webKnossos wrap (*.wkw) format
    - add/remove layers
    - update metadata (`datasource-properties.json`) 
    - up/downsample layers
    - compress layers 
    - add/remove magnifications
    - execute any of the `wkCuber` operations from your code
- manipulation of webKnossos skeleton annotations (*.nml) as Python objects
    - access to nodes, comments, trees, bounding boxes, metadata, etc.
    - create new skeleton annotation from Graph structures or Python objects
- interaction, connection & scripting with your webKnossos instance over the REST API
    - up- & downloading annotations and datasets

Please refer to [the documentation for further instructions](https://docs.webknossos.org/webknossos-py).

## Installation
The `webknossos` package requires at least Python 3.7+.

You can install it from [pypi](https://pypi.org/project/webknossos/), e.g. via pip:

```bash
pip install webknossos
```

## Examples
See the [examples folder](examples) or the [the documentation](https://docs.webknossos.org/webknossos-py).

## License
[AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html)
Copyright [scalable minds](https://scalableminds.com)

