cyberark-conjur-cli icon indicating copy to clipboard operation
cyberark-conjur-cli copied to clipboard

Enable SDK push to PyPi

Open sigalsax opened this issue 4 years ago • 0 comments

Summary

We push the CLI and SDK as a package to PyPi so that users with Python installed on their machine can easily pull the CLI for human-use and SDK for their application-use.

The push of the Client library to PyPi has been blocked as part of the CLI GA effort because the CLI was bumped to GA while the SDK hasn't been. To be given a GA status, our codebase needs to go through rigorous checks (quality, security, etc), UX designs, and documentation. The SDK hasn't gone through this process and therefore cannot bump it to GA. Because of this discrepancy we cannot continue pushing to PyPi

To overcome this we can:

  1. Invest to make the SDK GA and go back to pushing to PyPI keeping the two together
  2. Separate the two repositories so we can push them to PyPi individually
  3. Figure out how to push two separate artifacts (one for CLI one for Client) so that the client can stay under < 1.0.0 and the Client can be promoted to GA

See PR that blocked the push to Pypi https://github.com/cyberark/conjur-api-python3/pull/212

I recommend pursuing the second option to favor separation of duties.

EE on separating the CLI and the SDK :one: Build pipeline - (6 days, requires work closely with Infra) Building, testing, release :two: Design release process and implement (3 days) Packing and pushing to Pypi :three: Create development environment (2 days) :four: Map out overlapping logic between between CLI / SDK (1 day) :four: Create efficient way to development between two projects (2 days) :five: Make separation (5 days) :six: Refactor client.py from the SDK (2 days) :seven: Separate tests out and add supporting tests if required (3 days) :eight: Add documentation (README, CONTRIBUTING, release process) (3 days)

27 days of unparalleled work

sigalsax avatar Feb 24 '21 13:02 sigalsax