Skip to content

Commit

Permalink
Update README for Python extension API to point to examples (#21638)
Browse files Browse the repository at this point in the history
For #20949
  • Loading branch information
Kartik Raj authored Jul 14, 2023
1 parent f38f6e5 commit f4d7556
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 4 deletions.
2 changes: 2 additions & 0 deletions build/azure-pipelines/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
###############################################################################################
name: $(Date:yyyyMMdd)$(Rev:.r)

trigger: none

pr: none

resources:
Expand Down
27 changes: 23 additions & 4 deletions pythonExtensionApi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ This npm module implements an API facade for the Python extension in VS Code.

## Example

The source code of the example can be found [here](TODO Update example extension link here)

First we need to define a `package.json` for the extension that wants to use the API:

```jsonc
Expand All @@ -24,8 +22,29 @@ First we need to define a `package.json` for the extension that wants to use the
}
```

TODO insert example here
The actual source code to get the active environment to run some script could look like this:

```typescript
TODO
// Import the API
import { PythonExtension } from '@vscode/python-extension';

// Load the Python extension API
const pythonApi: PythonExtension = await PythonExtension.api();

// This will return something like /usr/bin/python
const environmentPath = pythonApi.environments.getActiveEnvironmentPath();

// `environmentPath.path` carries the value of the setting. Note that this path may point to a folder and not the
// python binary. Depends entirely on how the env was created.
// E.g., `conda create -n myenv python` ensures the env has a python binary
// `conda create -n myenv` does not include a python binary.
// Also, the path specified may not be valid, use the following to get complete details for this environment if
// need be.

const environment = await pythonApi.environments.resolveEnvironment(environmentPath);
if (environment) {
// run your script here.
}
```

Check out [the wiki](https://aka.ms/pythonEnvironmentApi) for many more examples and usage.
Empty file.

0 comments on commit f4d7556

Please sign in to comment.