Hi folks where can I find the python reference docs for the

Question

Hi folks where can I find the python reference docs for the automation library

enough-leather-70274 · Answer

I can see the guides at and there s a link at the bottom of the page to python pointing to but that idref doesn t exist

enough-leather-70274 · Answer

e g I m looking for the python equivalent of <https pkg go dev github com pulumi pulumi sdk v3 go auto Stack>

red-match-15116 · Answer

Yikes yeah something went wrong with the latest docgen I ll sort that out ASAP but that documentation is generated from the source code so you should be able to get the same info from the docstring on `Stack` for now

red-match-15116 · Answer

Is there anything specific you re looking for

enough-leather-70274 · Answer

I actually came to ask if there was a post pulumi up hook I could use to run our db migration scripts in python and realised it s exactly what the automation lib is prob for

enough-leather-70274 · Answer

But wanted to look at the api ref doc in full to see what was available and how to do it

enough-leather-70274 · Answer

So the docstring on Stack for python is where then

enough-leather-70274 · Answer

also another thing your go docs still say automation is in alpha which is why we ve steered clear of it so far but I guess that needs an update

red-match-15116 · Answer

I can do you one better for that specific use case Automation examples for python For database migration specifically

red-match-15116 · Answer

gt also another thing your go docs still say automation is in alpha which is why we ve steered clear of it so far but I guess that needs an update Thanks for the callout yeah we need to do a sweep and update those docs

enough-leather-70274 · Answer

gt For database migration specifically <https github com pulumi automation api examples tree main python database migration> Hah yeah that s the type of thing tho our db infra is totally isolated so no way to run them from public facing CI Need to invoke a migration lambda via boto basically Still it s the bit about wrapping the logic in our current ` main py` and associated components that I m interested in

enough-leather-70274 · Answer

I guess we d do away with the CLI altogether then i e wrap our current pulumi logic in a python program that uses the automation api then just invoke that from the command line when doing local dev

red-match-15116 · Answer

I m fixing up the python docs now so we ll get that updated soon gt Still it s the bit about wrapping the logic in our current ` main py` and associated components that I m interested in You can take a look at the <https github com pulumi automation api examples tree main python local program|local program> example to see how you can deploy invoke a pre existing CLI driven python pulumi program and then add on the bit that does the migration does that align more

red-match-15116 · Answer

You can always set it up in a way that it can be driven by both the CLI and via automation if using it via the local program route

enough-leather-70274 · Answer

Got it Yeah this is new to us so will have a tinker Will keep an eye on the docs too

red-match-15116 · Answer

Fix for docs should be merged in the morning PST <https github com pulumi docs pull 5859>

red-match-15116 · Answer

Docs are fixed now < enough leather 70274> The link should take you there

enough-leather-70274 · Answer

Thanks Komal defo an improvement FWIW I find the go docs way easier to navigate than the unindexed single page for python Know you re keen to show off the brand but DX should win here I think Can we access the native format e g readthedocs somewhere else

enough-leather-70274 · Answer

Also the formatting s a bit out of whack

red-match-15116 · Answer

yeah I totally hear you There s an open issue <https github com pulumi docs issues 4615> I m not a fan of our python docs just haven t had the time to address it

red-match-15116 · Answer

We unfortunately don t have a readthedocs version These are also sphinx generated we just do some <https github com pulumi docs blob master tools pydocgen pydocgen init py L2 L19|pretty weird stuff> to generate it this way I decided not to open that can of worms at the time But feel free to leave some comments on that issue so we can reconsider prioritizing