aiodynamo icon indicating copy to clipboard operation
aiodynamo copied to clipboard

Update documentations

Open hanscg opened this issue 5 years ago • 5 comments

These points are not in the documentations, so it might be confusing to those with minimum knowledge of Dynamo

  • Operations that can be done with client.Table (create, get_item, put_item, update_item, delete_item, query)
  • Usage example of KeyCondition and Condition/Filter Expressions
  • Exceptions that will be thrown

I will try to update it later.

hanscg avatar Dec 09 '20 06:12 hanscg

Please do 🙏🏿

dimaqq avatar Aug 24 '21 00:08 dimaqq

at least a basic example using query would be good. It's surprisingly hard to get started with very basic tasks using this library.

trondhindenes avatar Feb 20 '23 12:02 trondhindenes

at least a basic example using query would be good. It's surprisingly hard to get started with very basic tasks using this library.

The "New Pull Request" button is right there ;-)

Joking aside, I agree that it's too hard to get started. The library assumes you both know DynamoDB and are comfortable with some advanced(?) Python concepts like operator overloading.

I've tried to write better documentation several times but struggled with a few things, so if someone could maybe suggest something to deal with these, it might make it a lot easier for me to write better docs:

  • Where do I draw the line between "explaining DynamoDB" and "explaining aiodynamo"? I don't really think this library is the right place to explain how DynamoDB works but then again, you probably can't use this library if you don't...
  • What's a good schema/example data set that both makes sense to use with DynamoDB and leads to good example queries? Probably should be a split key schema to show query vs scan and if there's a reasonable secondary index, that would allow explaining even more...

ojii avatar Feb 20 '23 14:02 ojii

great artists steal, perhaps https://fastapi.tiangolo.com/tutorial/first-steps/ can serve as inspiration?

dimaqq avatar Feb 21 '23 01:02 dimaqq

I'd be happy to do a PR, but that depends on me understanding the system so I am actually able to write the doc.

trondhindenes avatar Feb 23 '23 12:02 trondhindenes