Skip to content

Conversation

@michael-groundlight
Copy link
Contributor

@michael-groundlight michael-groundlight commented May 6, 2022

See the README.md and Examples for details. I list several known TODOs at the bottom.

Everything under generated/ is autogenerated using openapi-generator, which uses spec/public-api.yaml.

Copy link
Contributor

@romerocesar romerocesar left a comment

Choose a reason for hiding this comment

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

normally I consider README like a dev guide and some other doc as a user guide. right now usage instructions are split between examples and readme

also, I prefer not to push lockfiles to libraries since they quickly result in the dev environment being different than the consuming env with minor updates to any dependency which we actually want to be able to test against and catch issues sooner than later

for the near future: it would be great to add notebooks with examples that can actually run out of the box

@@ -0,0 +1,33 @@
[tool.poetry]
name = "groundlight"
Copy link
Contributor

Choose a reason for hiding this comment

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

we may want to push a placeholder to pypi.org to sit on this since there are no namespaces in pypi and packages are identified only by name and number (not URL) so names have to basically be globally unique

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Member

@robotrapta robotrapta left a comment

Choose a reason for hiding this comment

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

Very exciting!

@michael-groundlight
Copy link
Contributor Author

normally I consider README like a dev guide and some other doc as a user guide. right now usage instructions are split between examples and readme

I moved a few things around to make the distinction clearer. Not perfect, but better.

also, I prefer not to push lockfiles to libraries since they quickly result in the dev environment being different than the consuming env with minor updates to any dependency which we actually want to be able to test against and catch issues sooner than later

Agreed, I've removed poetry.lock and added an entry in gitignore.

for the near future: it would be great to add notebooks with examples that can actually run out of the box

Added it to the TODO list.

@michael-groundlight michael-groundlight merged commit 67e9370 into main May 13, 2022
@michael-groundlight michael-groundlight deleted the initial-sdk-custom branch May 13, 2022 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants