Restructure SDK Based on Go Project Conventions #85
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.
Proposed changes
This restructures the project according to typical
go
conventions.This implements the following:
go
conventions by placing packages into thepkg
folder and break down modules by functionalitypkg/client
pkg/client/prerecorded
pkg/client/live
pkg/api/manage
. These are functions like ListProjects, etc.examples/prerecorded
andexamples/streaming
work as beforeexamples/projects
was added to verify the move of themanage
REST calls topkg/api/manage
. This implements an example toListProjects
on the DG Accountgo test
to consume the new structure.go tests
pass like before.NOTE: This PR restructures the project and updated any references to modules, struct variables and etc which captures the minimal changes needed for the restructure and nothing more. There is still some refactoring, obsoletion of dead code (due to just copying source files like
types.go
info other modules), etc, that need to be addressed. Those non-structural modifications will be done in a subsequent PR.Types of changes
What types of changes does your code introduce to the community Go SDK?
Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments
go tests
pass in thetests/
folderexample/prerecord
works like beforeexample/streaming
works like beforeexample/projects
proves the manage module works after the restructure (calling ListProjects for example)