Skip to content

Conversation

@james-leinas
Copy link

Consolidation efforts to include custom-code-in-automation-designer code snippets for public availability.

Changes included:

  • Updates to README.md (include references to custom-code-in-automation-designer)
  • Add plot-chromatogram example snippet and related docs
  • Include requirements.txt dependencies
  • Add custom-code-in-automation-designer template.py

@james-leinas
Copy link
Author

@damola-benchling -- created PR for migration efforts!

@@ -0,0 +1,26 @@
"""
Supported packages:
Copy link

@Psterne Psterne Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll have to figure out how to keep this list somewhat in sync with what we have in our manifest. Or add a comment that the versions and packages they get in Benchling might slightly vary from what we have here? Ideally they shouldn't copy paste this into the editor?

Copy link
Contributor

@damola-benchling damola-benchling left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have some minor feedback about the structuring of the READMEs and left comments there.

Also.
It seems the new structure will look like this:

examples/
├─ custom-code-in-automation-designer/
│  ├─ snippets/
├─ chem-sync-local-flask/

Curious what you think about:

  • moving examples/chem-sync-local-flask to examples/benchling-apps/chem-sync-local-flask now? (I think this was what we said we wanted anyway)
  • reducing the length of the name of custom-code-in-automation-designer? This is maybe a pet peeve, but long directory names can get gnarly when working in the terminal 😅

# Benchling App Python Examples
# Benchling Python Examples

The `examples/` directory contains Benchling App samples written by Benchling.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it will be good to structure the README a little more:

I'm thinking we should have H1 for each category, and H2 headers (and short description) for each example in the category (and we can even use collapsible summary)

Benchling Apps:

...

chem-sync-local-flask

Pre-existing description...

Custom Code in Automation Designer

Contains code snippets, include link to README for snippets

plot-chromatogram

short description...

README.md Outdated
Comment on lines 23 to 25

## Custom Code in Automation Designer
This project contains example snippets of code that can be utilized in a Custom Code step of the Benchling Automation Designer with Benchling Analysis.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea I think an overview statement should be sufficient here, and then we can just link to the README in examples/sippets/README.md so the rest of the content here will just be in there (rather than duplicated)

@james-leinas
Copy link
Author

james-leinas commented Dec 16, 2025

@Psterne @damola-benchling -- Updated the PR with your changes.

@Psterne -- pulled the current requirements.txt packages from custom code manifest and removed Benchling-SDK references.

@damola-benchling --

  • updated the structure we discussed to:
image
  • Renamed custom-code-in-automation-designer folder to custom-code-AD

  • Migrated the README.md content from /custom-code-AD folder to main README.md and added link to example snippets specific README.md

LMK any further feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants