Skip to main content

AIND Metadata Manager

AIND Metadata Manager is a Python package for managing, upgrading, and validating metadata files used in the Allen Institute for Neural Dynamics (AIND) data pipelines. It provides tools to upgrade metadata schemas, process and validate metadata, and support reproducible data workflows.

Features

  • Upgrade metadata files to the latest schema versions
  • Validate and process metadata for AIND data pipelines
  • Utilities for handling data descriptions, procedures, and processing metadata
  • Command-line and programmatic interfaces

Installation

  1. Clone the repository:
    git clone https://github.com/AllenNeuralDynamics/aind-metadata-manager.git
    cd aind-metadata-manager
    
  2. Create and activate a virtual environment (recommended):
    python -m venv venv
    venv\Scripts\activate  # On Windows
    # or
    source venv/bin/activate  # On macOS/Linux
    
  3. Install dependencies:
    pip install -e .
    pip install aind-data-schema aind-metadata-upgrader
    

Usage

As a Python package

from aind_metadata_manager.metadata_manager import MetadataManager, MetadataSettings
settings = MetadataSettings(input_dir='path/to/input', output_dir='path/to/output')
manager = MetadataManager(settings)
manager.create_processing_metadata()

Command Line Interface

A CLI may be available (see src/aind_metadata_manager/metadata_manager.py for details):

python -m aind_metadata_manager.metadata_manager --help

Development & Testing

  • Tests are located in the tests/ directory.
  • To run tests:
    venv\Scripts\python -m unittest discover -s tests -p "test_*.py" -v
    

Project Structure

  • src/aind_metadata_manager/ — Main package code
  • tests/ — Unit tests and test resources
  • docs/ — Documentation

Requirements

  • Python 3.10+
  • aind-data-schema
  • aind-metadata-upgrader
  • pydantic, pydantic-settings

License

This project is licensed under the terms of the MIT license. See the LICENSE file for details.

Citation

If you use this package, please cite as described in CITATION.cff.

Contributing

See CONTRIBUTING.md for guidelines.

Contact

For questions or support, please open an issue on GitHub or contact the Allen Institute for Neural Dynamics.

Metadata

Release files for aind-metadata-manager 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aind-metadata-manager 0.3.3
File Size Uploaded Provenance Actions
aind_metadata_manager-0.3.3.tar.gz 21.9 kB Without provenance Details for aind_metadata_manager-0.3.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aind-metadata-manager 0.3.3
File Interpreter ABI Platform Actions
aind_metadata_manager-0.3.3-py3-none-any.whl Python 3 none any Details for aind_metadata_manager-0.3.3-py3-none-any.whl

Total release size: 32.4 kB

Release files / aind_metadata_manager-0.3.3.tar.gz

Download URL aind_metadata_manager-0.3.3.tar.gz
Size 21.9 kB
Tags Source
SHA-256 checksum
How to use checksums
9565fcbe47074702de0c659278f2d752846bcac2304b6a587679e4db3369c7f7
BLAKE2b-256 checksum
How to use checksums
b8d88a0d7f0ec17609387d894e7a4ee79ef8b60583377a4efc6716b386c2de79
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / aind_metadata_manager-0.3.3-py3-none-any.whl

Download URL aind_metadata_manager-0.3.3-py3-none-any.whl
Size 10.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fa0f60a41c7fe313967444666c763555473a4f050c1c8c851684f437189d5421
BLAKE2b-256 checksum
How to use checksums
9233ead8d1df5f1bca5893a0669a7f55107ab93c7071173c19c58a77d11036b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for aind-metadata-manager 0.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page