Updating README.md. #51
Conversation
Signed-off-by: Software Developer <7852635+dsuhinin@users.noreply.github.com>
|
|
||
| or run: | ||
| ```bash | ||
| mage configure |
There was a problem hiding this comment.
seems like this should be the first, not alternate, option, since so much simpler
|
|
||
| Initially, we want to focus on supporting Postgres SQL. We chose [Gorm](https://gorm.io/) as ORM to interact with the database. | ||
|
|
||
| We do not generate any Go code based on the database schema. Gorm has generation capabilities but they didn't fit our needs. The plan would be to eventually assert the current code stil matches the database schema via an intergration test. |
| pip install git+https://github.com/jgiannuzzi/mlflow-go.git | ||
| ``` | ||
|
|
||
| ## Mage |
There was a problem hiding this comment.
should this go in the Developement section? I assume not necessary for end-user installation.
There was a problem hiding this comment.
yes and no, because a lot of actions you can do via mage so that's why I've decided to introduce firstly mage and then moving forward.
| The beauty of Mage is that we can use regular Go code for our scripting. | ||
| That being said, we are not married to this tool. | ||
|
|
||
| ## Development Setup |
There was a problem hiding this comment.
Things get pretty complicated at this point -- maybe move to a separate DEVELOPER.md?
There was a problem hiding this comment.
you mean move and link ?
There was a problem hiding this comment.
Yes, this probably should be in a CONTRIBUTING.md file.
|
|
||
| ## Installation | ||
|
|
||
| This package is not yet available on PyPI and currently requires the [Go SDK](https://go.dev) to be installed. |
There was a problem hiding this comment.
Why don't we push builds to PyPI so this is simpler?
There was a problem hiding this comment.
probably a bit later I think.
There was a problem hiding this comment.
We first need to move to https://github.com/mlflow/mlflow-go and set it up over there.
Might require helps from Databricks.
|
|
||
| ### Installation | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Consider rearranging the content to place mage configure at the top. Start with a brief explanation of its purpose, and then use an expandable section to provide more detailed information about its functionality.
| -s --log-level=debug | ||
| ``` | ||
|
|
||
| next `mage` tests targets are available: |
There was a problem hiding this comment.
Same, mage targets first, with expandable sections detailing their actions.
|
|
||
| This includes the generation of: | ||
|
|
||
| - Structs for each endpoint. ([pkg/protos](./protos/service.pb.go)) |
|
|
||
| ## Usage | ||
|
|
||
| ### Go server |
There was a problem hiding this comment.
For developers it would be interesting to mention mage dev, that is how I always start the thing.
No description provided.