Meta

• License: MIT License
• Author: Benchling Open Source
• Tags allotrope , allotropy , asm , benchling , converters
• Requires: Python >=3.10

Classifiers

• Development Status
  • 4 - Beta
• License
  • OSI Approved :: MIT License
• Programming Language
  • Python
  • Python :: 3.10
  • Python :: 3.11
• Typing
  • Typed

*Allotrope® is a registered trademark of the Allotrope Foundation; no affiliation with the Allotrope Foundation is claimed or implied.

Test Introduction

Welcome to allotropy -- a Python library by Benchling for converting instrument data into the Allotrope Simple Model (ASM).

View the list of instrument software currently supported in SUPPORTED_INSTRUMENT_SOFTWARE.

The objective of this library is to read text or Excel based instrument software output and return a JSON representation that conforms to the published ASM schema. Note that some schemas do not yet match the published ASM schema, in these cases the CHANGE_NOTES.md file included alongside the schema details the differences and proposed changes to ASM or the library schema. The code in this library does not convert from proprietary/binary output formats and so has no need to interact with any of the specific vendor softwares.

If you aren't familiar with Allotrope, we suggest you start by reading the Allotrope Product Overview.

We have chosen to have this library output ASM since JSON is easy to read and consume in most modern systems and can be checked by humans without any special tools needed. All of the published open source ASMs can be found in the ASM Gitlab repository.

This code is published under the permissive MIT license because we believe that standardized instrument data is a benefit for everyone in science.

Contributing

We welcome community contributions to this library and we hope that together we can expand the coverage of ASM-ready data for everyone. If you are interested, please read our contribution guidelines.

Usage

Convert a file to an ASM dictionary:

fromallotropy.parser_factoryimportVendor
fromallotropy.to_allotropeimportallotrope_from_file

asm_dict=allotrope_from_file("filepath.txt",Vendor.MOLDEV_SOFTMAX_PRO)

or, convert any IO:

fromallotropy.parser_factoryimportVendor
fromallotropy.to_allotropeimportallotrope_from_io

withopen("filename.txt")asf:
asm_dict=allotrope_from_io(f,Vendor.MOLDEV_SOFTMAX_PRO)

bytes_io=BytesIO(file_stream)
asm_dict=allotrope_from_io(bytes_io,Vendor.MOLDEV_SOFTMAX_PRO)

Specific setup and build instructions

.gitignore: used standard GitHub Python template and added their recommended JetBrains lines

Setup

Install Hatch: https://hatch.pypa.io/latest/ Install Python: https://www.python.org/downloads/ This library supports Python 3.10 or higher. Hatch will install a matching version of Python (defined in pyproject.toml) when it sets up your environment.

Tell git to use .githooks:

gitconfigcore.hooksPath.githooks

Dependencies

To add requirements used by the library, update dependencies in pyproject.toml:

• For project dependencies, update dependencies under [project].
• For script dependencies, update dependencies under [tool.hatch.envs.default].
• For lint dependencies, update dependencies under [tool.hatch.envs.lint].
• For test dependencies, update dependencies under [tool.hatch.envs.test].

Useful Hatch commands

List all environments:

hatchenvshow

Run all lint:

hatchrunlint:all

Auto-fix all possible lint issues:

hatchrunfix

Run all tests in the default python enviroment (currently: 3.11.9)

hatchruntest

Run all tests against all supported python versions (currently 3.10-3.12) Note: this is checked against in CI - your change must pass this to merge.

hatchruntest_all:test

Run against a specific python version (useful for debugging if a test is failing in one environment)

hatchruntest_all.py3.12:test

Run a specific test file (replace the filepath with your own):

hatchruntesttests/allotrope/allotrope_test.py

Run all tests with coverage:

hatchruntest:cov

Spawn a shell within an environment for development:

hatchshell

Publish

NOTE: only package admins can publish allotropy.

To publish a new version:

hatchrunscripts:update-version

Merge the resulting PR, and then run on main:

hatch build
hatch publish

Verified details

These details have been verified by PyPI

Maintainers

👁 Avatar for alejando.salgado from gravatar.com
alejando.salgado 👁 Avatar for nathan.stender from gravatar.com
nathan.stender 👁 Avatar for slopez-b from gravatar.com
slopez-b 👁 Avatar for stephen.worlow from gravatar.com
stephen.worlow

Unverified details

These details have not been verified by PyPI

Project links

• Documentation
• Issues
• Source

• Download URL: allotropy-0.1.137.tar.gz
• Upload date: Jun 19, 2026
• Size: 1.5 MB
• Tags: Source
• Uploaded using Trusted Publishing? No
• Uploaded via: python-httpx/0.25.0

Hashes for allotropy-0.1.137.tar.gz

Algorithm	Hash digest
SHA256	08e3670555f95140051b0b42f2a339836ad79297a063a793a9fae0654d58099b
MD5	bab091ea010df8beb67d4ffb9c1a5424
BLAKE2b-256	f180613ac04d82ad21cc9a3487a0d462b8644ff555f976175389f50a7c260338

See more details on using hashes here.

• Download URL: allotropy-0.1.137-py3-none-any.whl
• Upload date: Jun 19, 2026
• Size: 1.9 MB
• Tags: Python 3
• Uploaded using Trusted Publishing? No
• Uploaded via: python-httpx/0.25.0

Hashes for allotropy-0.1.137-py3-none-any.whl

Algorithm	Hash digest
SHA256	6136abb37d4c64c9a6ea54ab047e03adf36acf4019424ab812b3e1b03e3736d5
MD5	900e9008e3c32c6c1ff166aad4805342
BLAKE2b-256	ce417838f857a52b56c6f2f7fc8b07998f13306f89319ff1e393b63e75f6c5a9

See more details on using hashes here.