semvec/pypi-packages huggingface dataset:
yroom 0.0.10
Yjs sync and awareness protocol handler for a non-editing client (e.g. server)
Requires Python: >=3.7

[![PyPI version](https://badge.fury.io/py/yroom.svg)](https://badge.fury.io/py/yroom)

# Yroom

Python API to synchronize clients and distribute updates via the Yjs protocol. It's written in Rust and uses [Yrs](https://github.com/y-crdt/y-crdt) and [y-sync](https://github.com/y-crdt/y-sync).

It was built for [channels-yroom](https://github.com/stefanw/channels-yroom).

## Installation

```
pip install yroom
```

## API

See `yroom.pyi`.

## Development

[Maturin](https://www.maturin.rs) can be used to build `Yroom` inside a virtual environment.

```
maturin develop
```
perphix 0.0.1
Utilities and documentation for the collection, annotation, and usage of X-ray image sequences for surgical phase recognition.

# Perphix

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](
<https://opensource.org/licenses/MIT>)
[![PyPI](https://img.shields.io/pypi/v/perphix.svg)](
<https://pypi.org/project/perphix/>)
[![Documentation Status](https://readthedocs.org/projects/perphix/badge/?version=latest)](
<https://perphix.readthedocs.io/en/latest/?badge=latest>)

Utilities and documentation for the collection, annotation, and usage of X-ray image sequences for
surgical phase recognition, with a focus on percutaneous fracture fixation.

This repository is used by [Pelphix](https://github.com/benjamindkilleen/pelphix) to provide
data-related utilities and documentation. It classes for loading and processing data, as well as
documentation for the Perphix datasets. It is provided separately for ease of installation.

## Installation

Perphix can be installed from PyPI:

```bash
pip install perphix
```

### Development

Clone the repository and install from source using pip:

```bash
git clone git@github.com:arcadelab/perphix.git
cd perphix
pip install -e .
```

Alternatively, you can use the included `environment.yml` file to install an Anaconda environment.

```bash
conda env create -f environment.yml
conda activate perphix
```

## Documentation

The documentation for this project is hosted on [Read the Docs](https://perphix.readthedocs.io/en/latest/).

## Citation

If you find this work useful in your research, please consider citing:

```bibtex
@InProceedings{KilleenPelphix2023,
 author = {Killeen, Benjamin D. and Zhang, Han and Mangulabnan, Jan and Armand, Mehran and Taylor, Russel H. and Osgood, Greg and Unberath, Mathias},
 title = {{Pelphix: Surgical Phase Recognition from X-ray Images in Percutaneous Pelvic Fixation}},
 booktitle={Medical Image Computing and Computer Assisted Intervention -- MICCAI 2023},
 journal = {arXiv},
 year = {2023},
 publisher = {Springer International Publishing},
 address = {Cham},
 pages = {to appear},
}
```
scribe-updater 0.17.3
A tool to upgrade scribe configuration files
Requires Python: >=3.7,<4.0

### **Setup**
poetry runs a venv, so you need to run `poetry install` from the root of the repo first

#### **Run**
`poetry run updater`

#### **Test**
`poetry run pytest` 

#### **Coverage**
`poetry run pytest --cov` or `poetry run pytest --cov --cov-report=term-missing`

### **Publish to PyPi**
After adding credentials to be able to push to the python package index run the following cmd:
`poetry publish --build`

##### **Linting**
Install nox with:
`pip3 install nox`
add the path to your .bashrc and source it

run `nox -rs black`
##### **Testing with console.py**

from within the src/scribe_updater/ directory run the following:
`poetry run updater --target ../tests/test_input_1.json --ground ../tests/test_ground_1.json --output ./test_output`
'
##### **PBA Customer Spreadsheet Updater (`update.py`)**
Injects new scenarios from the ground truth into a customer spreadsheet.
##### **Caveats**
if you are getting an error that looks like this :<br> `Failed to create the collection: Prompt dismissed..`<br>
then export the following environment variable: <br>
`export PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring`

### **Usage**

basic use with no variables or mapping<br>
`updater -t target.json -g ground.json -o output.json`

use with variables (variables are only required when adding special products)<br>
`updater -t target.json -g ground.json -v variables.json -o output.json`

use with version map<br>
`updater -t target.json -g ground.json -m 3.3_to_3.7.json -o output.json`

use with variables & version maps<br>
`updater -t target.json -g ground.json -v variables -m 3.3_to_3.7.json -o output.json`


### **Version Mappings**

Version mappings are necessary when upgrading to a version that has scenarios that still exist but have been moved or their names have been changed. If you omit the version map the updater will still work but may delete or add scenarios that should not be in the configuration.

#### Available Mappings
<ol>
    <li>3.3_to_3.7.json (use this to upgrade to finie 3.8)</li>
    <li>3.3_to_3.6.json</li>
    <li>3.3_to_3.5.json (use this to upgrade to finie 3.8)</li>
</ol>