docs: rewrite README and add DEVELOPERS.md - #75
Open
smga3000 wants to merge 2 commits into
Open
Conversation
Replaces the two-line README with a definitional opening, install command, runnable Python and MCP snippets, and a map of the example folders so the content is discoverable by developers and AI assistants. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Covers running OpenMetadata locally, obtaining a JWT, Python environment setup with version matching, repository layout, and troubleshooting. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this changes
Replaces the two-line README with a proper landing page, and adds a
DEVELOPERS.mdlocal-setup guide.The README previously read, in full:
Why
This repo is what developers — and increasingly AI coding assistants — land on when looking for runnable OpenMetadata examples. It ranked for queries like "OpenMetadata python SDK" and "OpenMetadata API python code example", but the landing page offered no code, no install command, and no map of what's in the repo.
For AI-assisted coding specifically, retrieval is extractive: assistants lift complete, runnable snippets. A README with no code contributes nothing citable, so the repo could rank and still fail to help anyone.
README changes
pip install "openmetadata-ingestion~=1.13.1.0"stated explicitly, version-pinned (the package name is non-obvious —pip install openmetadatafails)data-ai-sdkand the LangChain one-linerfullyQualifiedNameDEVELOPERS.md
New file: Docker Compose quickstart, getting a JWT from Settings → Bots, Python venv setup, SDK/server version matching (the most common source of pydantic validation errors), repository layout, troubleshooting, and contributing guidelines.
Notes for reviewers
~=1.13.1.0) should be bumped as releases move.example_apis.pyandsdk-examples/README.md) were deliberately left out of this PR pending verification against a live server. They previously existed at those paths and are still linked from external sources, so restoring them is worth a follow-up.🤖 Generated with Claude Code