Metadata-Version: 2.1
Name: mat3ra-code
Version: 2025.10.24.post0
Summary: COre DEfinitions.
Author-email: "Exabyte Inc." <info@mat3ra.com>
License: # LICENSE
        
        Copyright 2022 Exabyte Inc.
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
           http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Software Development
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy
Requires-Dist: jsonschema >=2.6.0
Requires-Dist: pydantic >=2.7.1
Requires-Dist: mat3ra-esse >=2025.7.1-0
Requires-Dist: mat3ra-utils >=2024.5.15.post0
Provides-Extra: all
Requires-Dist: mat3ra-code[tests] ; extra == 'all'
Provides-Extra: tests
Requires-Dist: coverage[toml] >=5.3 ; extra == 'tests'
Requires-Dist: pre-commit ; extra == 'tests'
Requires-Dist: black ; extra == 'tests'
Requires-Dist: ruff ; extra == 'tests'
Requires-Dist: isort ; extra == 'tests'
Requires-Dist: mypy ; extra == 'tests'
Requires-Dist: pip-tools ; extra == 'tests'
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'

[![npm version](https://badge.fury.io/js/%40mat3ra%2Fcode.svg)](https://badge.fury.io/js/%40mat3ra%2Fcode)
[![License: Apache](https://img.shields.io/badge/License-Apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

# @mat3ra/code

@mat3ra/code houses COre DEfinitions (CODE) for use across the Mat3ra platform.
Its usage can be found in other open-source packages used in the platform.


### Installation

For usage within a javascript project:

```bash
npm install @mat3ra/code
```

For development:

```bash
git clone https://github.com/Exabyte-io/code.git
```


### Contribution

This repository is an [open-source](LICENSE.md) work-in-progress and we welcome contributions.

We regularly deploy the latest code containing all accepted contributions online as part of the
[Mat3ra.com](https://mat3ra.com) platform, so contributors will see their code in action there.

See [ESSE](https://github.com/Exabyte-io/esse) for additional context regarding the data schemas used here.

Useful commands for development:

```bash
# run linter without persistence
npm run lint

# run linter and save edits
npm run lint:fix

# compile the library
npm run transpile

# run tests
npm run test
```
