-
Notifications
You must be signed in to change notification settings - Fork 14
benchling-examples-python migration #32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
benchling-examples-python migration #32
Conversation
|
@damola-benchling -- created PR for migration efforts! |
...-designer/snippets/plot-chromatogram/HPLC_Chromatogram_Plot_(Absorbance, pH, Temperature).py
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,26 @@ | |||
| """ | |||
| Supported packages: | |||
There was a problem hiding this comment.
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?
damola-benchling
left a comment
There was a problem hiding this 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-flasktoexamples/benchling-apps/chem-sync-local-flasknow? (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. |
There was a problem hiding this comment.
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
|
|
||
| ## 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. |
There was a problem hiding this comment.
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)
|
@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.
LMK any further feedback! |

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