Skip to content

Commit

Permalink
added readme and some images
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidKutu committed Jul 2, 2020
1 parent 27b7e3f commit 664850d
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 52 deletions.
28 changes: 19 additions & 9 deletions README.md
@@ -1,17 +1,27 @@
# gather-for-the-python-extension README
# Gather for the Python extension

## Features
A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/VSCode) that adds the gather feature to the [Python extension](https://github.com/microsoft/vscode-python). Gather adds first-class support for refactoring code out of notebooks and into either a script, or another simplified notebook. It will give you only the necessary code you need to execute to reach your selected output.

Adds gather functionality to the Python Extension.
## Quick start

## Requirements
- **Step 1.** Install both the Python and the Gather extension for Visual Studio Code.

The Python Extension for Visual Studio Code.
<img src=./images/step1.PNG>

## Known Issues
- **Step 2.** Use either the Interactive Window of the Notebook Editor to do your work.

## Release Notes
<img src=./images/step2.PNG>

### 2020.8.0
- **Step 3.** When you're done, click the Gather icon <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
<path style="fill: currentColor !important; fill-rule: evenodd !important; clip-rule: evenodd !important" d="M1.5,1,1,1.5v3l.5.5h3L5,4.5v-3L4.5,1ZM2,4V2H4V4ZM1.5,6,1,6.5v3l.5.5h3L5,9.5v-3L4.5,6ZM2,9V7H4V9ZM1,11.5l.5-.5h3l.5.5v3l-.5.5h-3L1,14.5ZM2,12v2H4V12ZM12.5,5l-.5.5v6l.5.5h3l.5-.5v-6L15.5,5ZM15,8H13V6h2Zm0,3H13V9h2ZM9.1,8H6V9H9.1l-1,1,.7.6,1.8-1.8V8.1L8.8,6.3,8.1,7Z"/>
</svg> on your desired output and get your refactored code.

Initial release of gather
<img src=./images/step3.PNG>

## Questions and issues

- If you have a question about how to accomplish something with the extension, please [ask on Stack Overflow](https://stackoverflow.com/questions/tagged/visual-studio-code+python)
- If you come across a problem with the extension, please [file an issue](https://github.com/microsoft/vscode-python)
- Any and all feedback is appreciated and welcome!
- If someone has already [filed an issue](https://github.com/Microsoft/vscode-python) that encompasses your feedback, please leave a 👍/👎 reaction on the issue
- Otherwise please file a new issue
Binary file added images/step1.PNG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/step2.PNG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/step3.PNG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -2,7 +2,7 @@
"name": "gather",
"displayName": "Gather",
"description": "Adds gather functionality to the Python Extension",
"version": "2020.7.0-dev",
"version": "2020.7.0",
"publisher": "ms-python",
"author": {
"name": "Microsoft Corporation"
Expand Down
42 changes: 0 additions & 42 deletions vsc-extension-quickstart.md

This file was deleted.

0 comments on commit 664850d

Please sign in to comment.