Add an example on how to get started with the Python API #1474
Conversation
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
RyanGlScott
approved these changes
Nov 23, 2022
Comment on lines
5
to
6
| This starts an HTTP server with default settings, which means that | ||
| the server can be accessed at `http://localhost:8080/cryptol` |
There was a problem hiding this comment.
A general comment: this sentence should be indented three spaces so that it is at the same level of indentation as the "Run the Cryptol remote API server" sentence above. That way, GitHub will render this text with the same indentation as above. Currently, it looks like this:
Similar comments apply to all numbered bullet points below this one.
|
|
||
| > cryptol-remote-api http /cryptol | ||
|
|
||
| This starts an HTTP server with default settings, which means that |
There was a problem hiding this comment.
Suggested change
| This starts an HTTP server with default settings, which means that | |
| This starts an HTTP server with the default settings, which means that |
|
|
||
| > poetry run python | ||
|
|
||
| This runs a python shell within an environment setup by |
There was a problem hiding this comment.
Suggested change
| This runs a python shell within an environment setup by | |
| This runs a Python shell within an environment set up by |
|
|
||
| The URL is the one where we started the server in step 1. The second parameter resets | ||
| the state of the server. See `help("cryptol.connect")` for other options. | ||
| At this point `cry` is an object that we can use to interact with Cryptol. |
There was a problem hiding this comment.
Suggested change
| At this point `cry` is an object that we can use to interact with Cryptol. | |
| At this point, `cry` is an object that we can use to interact with Cryptol. |
|
|
||
| >>> it = cry.evaluate_expression("1+1") | ||
|
|
||
| This command sends the expression `1 + 1` to the server and the value `it` contains |
There was a problem hiding this comment.
Suggested change
| This command sends the expression `1 + 1` to the server and the value `it` contains | |
| This command sends the expression `1 + 1` to the server, and the value `it` contains |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Just an example of how to get started with the Python API