-
Notifications
You must be signed in to change notification settings - Fork 9
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
0079 Python Code Samples 2 #78
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
a64ad4a
initial draft
pdp2121 1818dc5
Add details
pdp2121 3156d53
rename file
pdp2121 1a3d935
rename file
pdp2121 8875f68
delete 2 duplicate ones, edit amount
jonathanlei 3ebc8e3
edit description
jonathanlei 8f1dbf0
bolding
jonathanlei File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| ID: 0079 | ||
| Discussion: https://github.com/XRPLBounties/Proposals/discussions/79 | ||
| Category: Technical Documentation | ||
| Status: Open | ||
| Amount: $5,000 | ||
| --- | ||
|
|
||
| # Python Code Samples 2 | ||
|
|
||
| ## This will not be merged until we receive budget approval even if we get 3+ technical approvals. Once merged, this bounty is ready to be worked on, please hold off starting work till merging. ## | ||
|
|
||
| ## Overview | ||
|
|
||
| Currently, our Python documentations have [code snippets](https://github.com/XRPLF/xrpl-py/tree/master/snippets) and [code samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples) for some common usecases. However, there needs to be more examples to capture common tasks that users would want the library to do. Developers would benefit from additional relevant, high quality, well-documented examples in Python. | ||
|
|
||
| ## Details | ||
|
|
||
| To add missing code samples, follow the instructions at the bottom of the page, under **Contribute Code Samples**. | ||
|
|
||
| https://xrpl.org/code-samples.html | ||
|
|
||
| ## Milestones | ||
|
|
||
| | # | Description | Details | Proposed Potential Award | Open? | | ||
| | --- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----- | | ||
| | 1 | NFT | Mint (or batch mint) and burn an [NFT Token](https://xrpl.org/non-fungible-tokens.html#non-fungible-tokens-overview), assign an authorized minter, transfer NFT tokens (create, cancel, and accept offer). | $1500 | Open | | ||
| | 2 | Require Destination Tags | Enable [Require Destionation Tags](https://xrpl.org/require-destination-tags.html#require-destination-tags) for an account. | $500 | Open | | ||
| | 3 | Decentralized Exchange | Buy and sell tokens in the [decentralized exchange](https://xrpl.org/decentralized-exchange.html). Follow this [guidance](https://xrpl.org/decentralized-exchange.html) in JavaScript. | $500 | Open | | ||
| | 4 | Tickets | List which [Tickets](https://xrpl.org/use-tickets.html) are outstanding against one’s own account and use Tickets to collect signatures for multisign transactions. | $750 | Open | | ||
| | 5 | Account Deletion | Delete (or blackhole) an account. | $500 | Open | | ||
| | 6 | NFTs | List an account’s [NFT pages](https://xrpl.org/nftokenpage.html#nftokenpage) and see token offers for that account’s NFTs. | $750 | Open | | ||
| | 7 | Memo | Validate and send a [Memo](https://xrpl.org/transaction-common-fields.html#memos-field). | $500 | Open | | ||
|
|
||
| When submitting a PR completing one of these milestones, please link to this markdown file for the bounty: | ||
|
|
||
| - A milestone is complete only after the relevant code sample has been approved, merged, and deployed onto XRPL.org. | ||
| - All of these code samples must have feature parity with the existing equivalent code samples in other languages. | ||
| - They must also be well-documented to be a useful learning reference, not just working code which performs the task. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is for xrpl.org only we can remove Use Tickets, Escrow History, and Tickets should be removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think Tickets exists on xrpl.org for Python (List which Tickets are outstanding against one’s own account and use Tickets to collect signatures for multisign transactions)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use tickets does
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't realize this bounty was for updating the code in guides. Do we need to update the description of the bounty then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://xrpl.org/code-samples.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jonathanlei This is where I was looking. https://github.com/XRPLF/xrpl-dev-portal/blob/master/content/_code-samples/use-tickets/py/use-tickets.py
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah description could be more clear
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah but that's for use-tickets, Tickets have a different description - List which Tickets are outstanding against one’s own account and use Tickets to collect signatures for multisign transactions.