Vaibhav Kumar
09/14/2022, 6:56 PMGuy Hardonag
09/14/2022, 7:27 PMVaibhav Kumar
09/15/2022, 5:29 AMGuy Hardonag
09/15/2022, 8:07 AMlong_description
field in the file https://github.com/treeverse/lakeFS/blob/master/clients/python/setup.py
You should edit the long description, so it will contain the information requested in the issue.
Just notice this file is generated using open-api ( you can’t just edit it)
This data is generated in the Makefile (client-python: api/swagger.yml ## Generate SDK for Python client
)Vaibhav Kumar
09/15/2022, 12:36 PMGuy Hardonag
09/15/2022, 1:15 PMmake client-python
the long_description
in Setup.py
will include a link to the pydocs
.Vaibhav Kumar
09/15/2022, 6:52 PMlong_description
and so just changing the setup and recompiling should workGuy Hardonag
09/15/2022, 8:36 PMsetup.py
file, the next time the python client will be generated your changes will be overwritten.
You could mimic it running the following steps:
1, make a change in setup.py
2. Run make client-python
from the root of the project
3. go back to setup.py
- your changes where removed
your change should still exist after running make client-python
The python client is built in the Makefile, using the openapi-generator
you could read about it more hereVaibhav Kumar
09/16/2022, 6:57 PMMakefile
or swagger.yml
@Guy HardonagGuy Hardonag
09/16/2022, 7:03 PMVaibhav Kumar
09/16/2022, 7:06 PMGuy Hardonag
09/16/2022, 7:16 PMVaibhav Kumar
09/16/2022, 8:38 PMGuy Hardonag
09/17/2022, 3:12 AMVaibhav Kumar
09/17/2022, 3:56 AMGuy Hardonag
09/17/2022, 3:59 AMVaibhav Kumar
09/19/2022, 5:53 AMGuy Hardonag
09/19/2022, 5:56 AMsetup.py
file after the python client is generated.
I will look into it today and get back to you by the end of the dayVaibhav Kumar
09/19/2022, 6:01 AMGuy Hardonag
09/19/2022, 7:01 AMVaibhav Kumar
09/19/2022, 5:55 PMItai David
09/19/2022, 5:58 PMVaibhav Kumar
09/19/2022, 6:04 PMItai David
09/19/2022, 6:16 PMsetup.py
, after the client is generated. Did I get this correctly?Vaibhav Kumar
09/19/2022, 6:20 PMItai David
09/19/2022, 6:23 PMVaibhav Kumar
09/19/2022, 6:27 PMItai David
09/20/2022, 4:13 AMVaibhav Kumar
09/20/2022, 4:28 AMItai David
09/21/2022, 1:04 PMVaibhav Kumar
09/21/2022, 1:10 PMItai David
09/21/2022, 2:11 PM--additional-properties
flag. Looking at the code it seems it should allow an override with appDescription
key, but looks like it is ignoredVaibhav Kumar
09/21/2022, 2:26 PMItai David
09/21/2022, 2:35 PMVaibhav Kumar
09/21/2022, 3:05 PMItai David
09/22/2022, 12:56 AMlakeFS
work (bringing a server up, configuring the client etc.) - we should have all the required info documented, with most of it as a step-by-step guides). It will probably need some spark
work too - in case you are up to itsetup.py
. It is currently identical to the one used by OpenAPI Generator, but you can edit the long_description
string to fit your needs.
Feel free to branch-out from my branch https://github.com/treeverse/lakeFS/tree/2344-pyhton-client-project-description, or to merge it to yours.
Good luckVaibhav Kumar
09/22/2022, 4:26 AMItai David
09/22/2022, 10:55 AMVaibhav Kumar
09/22/2022, 12:55 PMmake client-python
is replacing my changes. I have pulled your branch to apply these changes on.Itai David
09/22/2022, 3:11 PMsetup.mustache
template file I added. The generator creates setup.py
based on that template. The one I submitted is the default one. I think that be adding your changes to setup.mustache
will have them reflected in setup.py
. Can you give it a go?Vaibhav Kumar
09/26/2022, 11:38 AMsetup.mustache
but if I clone from your branch I am not able to raise a PR. I get permission denied, I am not able to create multiple forks as well.Itai David
09/26/2022, 1:20 PMVaibhav Kumar
09/27/2022, 5:02 PMItai David
09/27/2022, 5:12 PMVaibhav Kumar
09/27/2022, 7:48 PMTest / Run Linters and Checkers (pull_request)
has failed and rest has passed, is that fine?Itai David
09/27/2022, 9:33 PMVaibhav Kumar
09/28/2022, 11:57 AMmake client-python
again which auto generated code to setup.py with my changes which I had put in setup.mustache
. Is that what you were asking for? @Itai DavidItai David
09/28/2022, 12:57 PMsetup.py
to match the one that will be generated by the build
Thank you @Vaibhav KumarVaibhav Kumar
09/28/2022, 12:58 PMItai David
09/28/2022, 1:00 PM