supabase-py icon indicating copy to clipboard operation
supabase-py copied to clipboard

Published 20 hours ago • verified publisher icon supabase-community

Update Documentation

Open J0 opened this issue 4 years ago • 5 comments
trafficstars

Improve documentation

Documentation as a whole is missing from the client library. It would be nice if we could furnish the [Sphinx Page] (https://supabase.readthedocs.io/en/develop/) with relevant documentation preferably from autodoc.

Currently this would mean documenting:

  • [ ] Auth
  • [ ] Storage
  • [ ] QueryBuilder
  • [ ] Realtime

J0 avatar Jul 26 '21 02:07 J0

Hey @J0 I would like to work on this issue. How can I proceed further? Also is the issue part of Hacktoberfest 2021?(just curious)

manavmodi22 avatar Oct 02 '21 06:10 manavmodi22

@manavmodi22 Yes! Any issue is part of Hacktoberfest 2021, since the whole library is participating. Feel free to go for it :smile: !

dreinon avatar Oct 02 '21 09:10 dreinon

Hey @manavmodi22 I would like to know, are you working on all the pointers? If you wish and like it, maybe we could split up the task. Also would like to confirm from @darora is it possible to split up the task? 🤔

siddhiiguptaa avatar Oct 03 '21 12:10 siddhiiguptaa

hey @siddhiiguptaa feel free to work on the issue. I am not working on it, currently..

manavmodi22 avatar Oct 03 '21 13:10 manavmodi22

Hey all,

Yup as @dreinon has mentioned feel free to go for the issue. Everything here is part of hacktoberfest. You can take a look in the docs folder to get a rough idea of how to proceed. We use Sphinx for documentation.

J0 avatar Oct 03 '21 19:10 J0

Are there any other open issues related to docs for supabase storage? Would love to contribute.

arshamg avatar Jan 29 '23 17:01 arshamg

Hey @arshamg,

Definitely, love to have you on board ! Let me get back to you after work- feel free to bump me again if you don't hear from me by mid-day tomorrow

J0 avatar Jan 30 '23 02:01 J0

Hey!

Docs wise there's a yaml file - https://github.com/supabase/supabase/blob/master/spec/supabase_py_v2.yml which corresponds to the docs section and describes most of the methods. I think not everything that's implemented is covered - if you're up for it you could enhance that. One example of undocumented library features would be storage image transformations

Alternatively, if you'd be open to library contributions I think there's still a few methods like upload which don't support all use cases cleanly (e.g. file upload) or don't support the full set of options that the js lib offers.

Hope this helps in some way - lmk if there are questions

J0 avatar Jan 30 '23 20:01 J0

Thanks! The yaml file looks like a great place to start :)

arshamg avatar Jan 31 '23 01:01 arshamg

Sounds good! Feel free to let me know if there's any way I can be helpful

J0 avatar Feb 01 '23 00:02 J0

This should now be documented on the Supabase site and should be gradually updated as new bindings are released- https://supabase.com/docs/reference/python/introduction

J0 avatar Sep 29 '23 02:09 J0