Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make nebari API private #1778

Merged
merged 4 commits into from
May 30, 2023
Merged

make nebari API private #1778

merged 4 commits into from
May 30, 2023

Conversation

pmeier
Copy link
Member

@pmeier pmeier commented May 3, 2023

Implements 4. of nebari-dev/governance#37 in three steps:

  1. 62379f4: Introduce a src/nebari layout. Right now we have the package directly in our repository root. Since we will ultimately have a nebari as well as a _nebari package, it is useful to tuck them together in one folder. This is done by pytest, which we are following with this API change, and many other Python projects as well.
  2. be85b66: make nebari package private by renaming it to _nebari.
  3. 3181f57: reintroduce a public nebari package that does nothing but expose the CLI and a __version__ attribute.

I'll send one commit per step outlined above to make it easier to review. Since the diff will get quite large, I advise reviewers to go commit by commit.

This PR will conflict with basically every other open PR and every patch that was merged into develop after I have started. To keep disruption to a minimum, I plan to only rebase once after this PR has been approved. For all other open PRs, I'm available for helping to migrate them. Tag me there if you need help.

@github-actions
Copy link

💰 Infracost estimate: monthly cost will not change

Project Previous New Diff
All projects $73 $73 $0

8 projects have no cost estimate changes.

Infracost output
──────────────────────────────────
The following projects have no cost estimate changes: nebari-dev/nebari/data/stages/01-terraform-state/gcp (Module path: 01-terraform-state/gcp), nebari-dev/nebari/data/stages/02-infrastructure/gcp (Module path: 02-infrastructure/gcp), nebari-dev/nebari/data/stages/03-kubernetes-initialize (Module path: 03-kubernetes-initialize), nebari-dev/nebari/data/stages/04-kubernetes-ingress (Module path: 04-kubernetes-ingress), nebari-dev/nebari/data/stages/05-kubernetes-keycloak (Module path: 05-kubernetes-keycloak), nebari-dev/nebari/data/stages/06-kubernetes-keycloak-configuration (Module path: 06-kubernetes-keycloak-configuration), nebari-dev/nebari/data/stages/07-kubernetes-services (Module path: 07-kubernetes-services), nebari-dev/nebari/data/stages/08-nebari-tf-extensions (Module path: 08-nebari-tf-extensions)
Run the following command to see their breakdown: infracost breakdown --path=/path/to/code

──────────────────────────────────
11 cloud resources were detected:
∙ 4 were estimated, all of which include usage-based costs, see https://infracost.io/usage-file
∙ 7 were free:
  ∙ 6 x google_project_iam_member
  ∙ 1 x google_service_account

This comment will be updated when the cost estimate changes.

Is this comment useful? Yes, No, Other

@pmeier
Copy link
Member Author

pmeier commented May 24, 2023

All CI failures on 62379f4 are tracked in #1817. As discussed in yesterday's community meeting, I'm going to ignore these and move forward with the PR.

@pmeier pmeier marked this pull request as ready for review May 24, 2023 12:02
@pmeier
Copy link
Member Author

pmeier commented May 24, 2023

Same deal as in #1778 (comment) with be85b66 and 3181f57.

@pavithraes pavithraes added needs: review 👀 This PR is complete and ready for reviewing and removed status: in progress 🏗 This task is currently being worked on labels May 26, 2023
Copy link
Member

@costrouc costrouc left a comment

Choose a reason for hiding this comment

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

Looks great to me @pmeier and I'm in favor of merging this earlier rather than later. Once you give the merge conflicts I'm in favor of immediately merging.

I like our minimal nebari interface now of nebari/__init__.py and nebari/__main__.py

@pavithraes pavithraes added status: approved 💪🏾 This PR has been reviewed and approved for merge and removed needs: review 👀 This PR is complete and ready for reviewing labels May 30, 2023
@pmeier pmeier merged commit 0436553 into develop May 30, 2023
26 checks passed
@pmeier pmeier deleted the private branch May 30, 2023 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:developer-experience 👩🏻‍💻 status: approved 💪🏾 This PR has been reviewed and approved for merge
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

None yet

3 participants