Metadata-Version: 2.4
Name: aind-metadata-upgrader
Version: 0.2.3
Summary: Generated from aind-library-template
Author: Allen Institute for Neural Dynamics
License: MIT
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aind-data-schema
Requires-Dist: packaging
Requires-Dist: aind-data-access-api[docdb]
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: interrogate; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: Sphinx; extra == "dev"
Requires-Dist: tzlocal; extra == "dev"
Requires-Dist: furo; extra == "dev"
Requires-Dist: aind-metadata-upgrader[sync]; extra == "dev"
Provides-Extra: sync
Requires-Dist: aind-data-access-api[rds]; extra == "sync"
Dynamic: license-file

# aind-metadata-upgrader

[![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
![Code Style](https://img.shields.io/badge/code%20style-black-black)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
![Interrogate](https://img.shields.io/badge/interrogate-100.0%25-brightgreen)
![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?logo=codecov)
![Python](https://img.shields.io/badge/python->=3.7-blue?logo=python)

## I want to run the upgrader

```python
from aind_metadata_upgrader.upgrade import Upgrade

# <Your code here: load your data as a dictionary, e.g. json.load(f)>

upgraded_record = Upgrade(data)
upgraded_record.save()
```

## I want to develop new upgraders

Add a new `CoreUpgrader` class, then include it in the `MAPPINGS` object.

## I want to run the upgrader in sync mode, i.e. to upgrade all assets to DocDB

```python
from aind_metadata_upgrader.sync import run
run()
```
