Metadata-Version: 2.1
Name: swanportallocator
Version: 1.0.0
Summary: Extension that provides a port allocation mechanism to other SWAN components
Home-page: https://github.com/swan-cern/jupyter-extensions
Author: SWAN Admins
License: AGPL-3.0
Keywords: Jupyter,Notebooks,SWAN,CERN
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Framework :: Jupyter
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# SwanPortAllocator

Extension that provides a port allocation mechanism to other SWAN components.

## Requirements

* pyzmq

## Install

```bash
pip install swanportallocator
```

## Usage

Configure the server extension to load when the notebook server starts

```bash
 jupyter serverextension enable --py --user swanportallocator
```

Class `swanportallocator.portallocator.PortAllocatorClient` can be used to connect to the port allocator process and get a given number of free ports.


