Skip to content

Update dependency verification doc, pull out snippets#196

Merged
dantasse merged 2 commits intomainfrom
dantasse/geneva_snippets
Mar 24, 2026
Merged

Update dependency verification doc, pull out snippets#196
dantasse merged 2 commits intomainfrom
dantasse/geneva_snippets

Conversation

@dantasse
Copy link
Contributor

  • the Dependency Verification doc had some outdated references to the old ManifestBuilders
  • we can't keep manually updating these though! luckily @prrao87 is ahead of us and has made snippets that can be tested. So in the future, we bump the version of geneva, run the tests again, and they will find things like this that don't work
  • probably we should pull out all our code snippets like this, in all our docs! Claude is good at it. I may try one massive snippet PR, or else just do it bit by bit; update each doc when I touch it next.

Question for @prrao87, to double check: when I want to update one of these snippets in the future, I just update the test, right? and then the mdx_snippets_gen.py will pull that updated code into the real mdx file?

description = "Add your description here"
readme = "README.md"
requires-python = ">=3.13"
requires-python = ">=3.12,<3.14"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Geneva needs 3.12 :(

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm adding 3.13 right now.

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

and actually has been supporting 3.10

but this looks good to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

woohoo! ok, sounds good.

<CodeGroup>
```python Python icon="python"
from geneva.manifest.builder import GenevaManifestBuilder
from geneva.manifest.builder import PipManifestBuilder
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This little bit is still untested because the env_vars method was just added today; once it's in the next release we can pull it out into a snippet as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

both of these apis are valid but pip is preferred.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope, GenevaManifestBuilder doesn't exist anymore, that's what got me started on this whole thing anyway 😆

@mintlify
Copy link
Contributor

mintlify bot commented Mar 24, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lancedb-bcbb4faf 🟢 Ready View Preview Mar 24, 2026, 4:31 PM

@@ -0,0 +1,16 @@
{/* Auto-generated by scripts/mdx_snippets_gen.py. Do not edit manually. */}

export const PyCondaManifestInline = "from geneva.manifest.builder import CondaManifestBuilder\n\nmanifest = (\n CondaManifestBuilder.create(\"my-manifest\")\n .conda({\n \"channels\": [\"conda-forge\"],\n \"dependencies\": [\n \"python=3.10\",\n \"ffmpeg<8\",\n \"torchvision=0.22.1\",\n ],\n })\n .build()\n)\n";
Copy link
Contributor

Choose a reason for hiding this comment

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

nit:
using triple quotes """" or ''' would allow this to be formatted and more readable.

Copy link
Contributor Author

@dantasse dantasse Mar 24, 2026

Choose a reason for hiding this comment

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

Added a feature-request issue: #197 (@prrao87 idk where you're tracking these, and it's not critical anyway bc the snippets are readable in the docs, but it's there so you can track it however you like)

Copy link
Contributor

@jmhsieh jmhsieh left a comment

Choose a reason for hiding this comment

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

docs content looks good to me.

@dantasse dantasse merged commit adc8bff into main Mar 24, 2026
2 checks passed
@dantasse dantasse deleted the dantasse/geneva_snippets branch March 24, 2026 19:47
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.

2 participants