odpi / egeria-python Goto Github PK

Name

egeria-python

Owner

dwolfson

Deliverable

Provides a Python 3.x client for Egeria

Build, test and CI-CD process

• Build a Python module

• use latest Python version 3.11

Dependencies

No build dependency
Access to an egeria platform will be needed at runtime

Justification

• Specific ci/cd process - to build a library
• New language - python (only jupyter notebooks currently are python)
• different sub-community of a) developers b) users

Assumptions

Yes

Additional Information

Initial focus likely to be on asset-consumer-client

Work Plan

Before creating the repo

• review overall request & get clarifications
• get approval on developer/TSC call from maintainers

Creating the repo

• Create the repo under the odpi organization (default gitignore, license, readme)
• Setup branch protection rules
• Set pull request options (allow merge, squash, rebase, suggest updating, allow automerge, do not delete head)
• Update security settings in repo (policy, advisories, alerts)
• set up permissions

First steps

• Initial code-drop (author)

Getting CI/CD started & refining settings

• Add initial build script for PR (including gradle wrapper if required)
• Add initial build script for merge

Further Refinement

• Add link in egeria docs to new repo describing purpose ( https://github.com/odpi/egeria-docs/blob/main/site/docs/education/tutorials/git-and-git-hub-tutorial/egeria-git-repositories.md )
• Add to connector catalog, if new repo is for connector ( https://github.com/odpi/egeria-docs/blob/main/site/docs/connectors/index.md )
• Add to release process docs ( https://github.com/odpi/egeria-docs/blob/main/site/docs/guides/contributor/release-process/index.md )
• Add required credentials for publishing to container repos, maven central etc
• Add artifact signing if needed
• Add dependabot config
• Add CodeQL
• Add to LFX ( https://projectadmin.lfx.linuxfoundation.org/project/a092M00001IV4JtQAL ) for
  • LFXSecurity
  • LFAnalytics
• Add check for stale defects
• Add any required issue tags

Release

• Add release pipeline

In the README it says "
There is initial support for many of Egeria's services including configuraiton, operation, and use. This client depends on Egeria 4.4 Snapshot and above - although most of the functions may work on earlier versions of Egeria as well."

some nits:

• configuraiton spelling
• and use. I am not sure what this means. Maybe mention the other omvs capabilities you current support explicitly.
• the client can only depend on one version of Egeria- it can support higher versions - I think. So I suggest rephrasing "Egeria 4.4 Snapshot and above". If this is not a strict dependancy on the JAVA code, maybe say will work with Egeria 4.4 Snapshot and above.