Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentations #68

Open
hanscg opened this issue Dec 9, 2020 · 5 comments
Open

Update documentations #68

hanscg opened this issue Dec 9, 2020 · 5 comments

Comments

@hanscg
Copy link
Contributor

hanscg commented Dec 9, 2020

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.

@dimaqq
Copy link
Contributor

dimaqq commented Aug 24, 2021

Please do 🙏🏿

@trondhindenes
Copy link

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

@ojii
Copy link
Contributor

ojii commented Feb 20, 2023

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...

@dimaqq
Copy link
Contributor

dimaqq commented Feb 21, 2023

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

@trondhindenes
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants