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

Various updates #54

Merged
merged 26 commits into from
Mar 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
d94e938
Update to get all results
jamiehewitt15 Feb 20, 2025
51b067e
Updating algorithm
jamiehewitt15 Feb 20, 2025
edf0be1
Updating to send request with updated nonce and signature
jamiehewitt15 Feb 20, 2025
c1eb9a3
Adding debugging
jamiehewitt15 Feb 20, 2025
859806b
Saving tar file
jamiehewitt15 Feb 25, 2025
2ec9eb5
Updating default folder for results
jamiehewitt15 Feb 25, 2025
c6e0f6d
Updating default py algorithm
jamiehewitt15 Feb 25, 2025
cd87a46
Updating JS algorithm
jamiehewitt15 Feb 25, 2025
8cb5050
Removing unused config object
jamiehewitt15 Feb 25, 2025
46ff958
Allowing users to pick the docker image and tag
jamiehewitt15 Feb 25, 2025
343e67f
Adding extra py algorithm for testing
jamiehewitt15 Feb 25, 2025
cd004a3
Updating signature for the startCompute request
jamiehewitt15 Feb 26, 2025
986d9ad
Updates for signature
jamiehewitt15 Feb 26, 2025
837d495
Updating tests
jamiehewitt15 Feb 26, 2025
05b5fc5
Update
jamiehewitt15 Feb 26, 2025
db6bf9e
Removing output files from git repo
jamiehewitt15 Feb 26, 2025
6f1771b
Updates to package.json for build
jamiehewitt15 Feb 26, 2025
74ba3dc
adding license
jamiehewitt15 Feb 26, 2025
000fcc8
Updating publisher ID
jamiehewitt15 Feb 27, 2025
ad51b6f
Updating display name
jamiehewitt15 Feb 27, 2025
26f1888
Update to allow datasets in json format to be useed
jamiehewitt15 Mar 3, 2025
e638fb8
Fixing test for updated name
jamiehewitt15 Mar 3, 2025
ab95cfb
Adding logo to maketplace listing
jamiehewitt15 Mar 3, 2025
ca513d7
Adding timeout to request
jamiehewitt15 Mar 3, 2025
ead6b62
Updating readme
jamiehewitt15 Mar 4, 2025
fbc9215
Updating readme with screenshots and setup explanation
jamiehewitt15 Mar 5, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 201 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
142 changes: 72 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,108 +1,110 @@
# Ocean Protocol VSCode Extension

This VSCode extension enables you to interact with Ocean Protocol directly from your development environment. You can run compute jobs and test algorithms without leaving VSCode.
Run compute jobs on Ocean Protocol directly from VS Code. The extension automatically detects your active algorithm file and streamlines job submission, monitoring, and results retrieval. Simply open a python or javascript file and click **Start Compute Job**.

![Ocean Protocol VSCode Extension](./screenshots/main-screenshot.png)

## Features

- 🌊 **Ocean Protocol Integration**: Direct integration with Ocean Protocol's core functionality
- 💻 **Compute-to-Data**: Start and monitor compute jobs using JavaScript or Python algorithms
- 🔄 **Active File Integration**: Automatically detects and uses currently open .js or .py files as algorithms
- 📁 **Results Management**: Specify output locations and view computation results directly in VSCode
### 🚀 One-Click Compute Jobs

## Prerequisites
Select your algorithm, choose a dataset, and run compute jobs with a single click.

- Node.js (version specified in `.nvmrc`)
- VSCode version 1.93.0 or higher
- Git
### 📊 Real-Time Monitoring

## Running the extension locally
Track job progress and view algorithm logs directly in VS Code.

1. Clone the repository:
### 📁 Automatic Results Handling

```bash
git clone https://github.com/your-username/ocean-protocol-vscode
cd ocean-protocol-vscode
```
Results are automatically saved and opened when your job completes.

2. Install dependencies:
## Getting Started

```bash
npm install
```
1. Install the extension from the VS Code Marketplace
2. Open the Ocean Protocol panel from the activity bar
3. Configure your compute settings:
- Node URL (pre-filled with default Ocean compute node)
- Optional private key for your wallet
4. Select your files:
- Algorithm file (JS or Python)
- Optional dataset file (JSON)
- Results folder location
5. Click **Start Compute Job**
6. Monitor the job status and logs in the output panel
7. Once completed, the results file will automatically open in VSCode

3. Build the extension:
### Requirements

```bash
npm run compile
```
VS Code 1.96.0 or higher

4. Open in VSCode:
### Extension Layout

- Press F5 to start debugging
- This will open a new VSCode window with the extension loaded
The extension adds a dedicated Ocean Protocol section to the activity bar. Here you can:

## Usage
- Configure compute settings (Ocean Node URL, Private Key).
- Optionally select a dataset file.
- Choose a folder to store compute results.
- Start a compute job with the current algorithm file automatically detected.

### Extension Layout
### Starting a Compute Job

The extension adds a new Ocean Protocol icon to the activity bar. Clicking it reveals several sections:
1. Navigate to the "Start Compute Job" section.
2. Ensure your active file is either a JavaScript or Python algorithm.
3. Optionally select a dataset file.
4. Choose a folder for saving results.
5. Click **Start Compute Job**.
6. Monitor the job status and logs in the output panel.
7. Once completed, the results file will automatically open in VSCode.

1. **Setup**
## Optional Setup

- Optional: Configure RPC URL, or use the default.
- Optional: Set Ocean Node URL, or use the default.
- Optional: Enter private key for transactions, or use the default.
- Custom Compute Node: Enter your own node URL or use the default Ocean Protocol node
- Wallet Integration: Use auto-generated wallet or enter private key for your own wallet
- Custom Docker Images. If you need a custom environment with your own dependencies installed, you can use a custom docker image. Default is oceanprotocol/algo_dockers (Python) or node (JavaScript)
- Docker Tags: Specify version tags for your docker image (like python-branin or latest)
- Algorithm: The vscode extension automatically detects open JavaScript or Python files. Or alternatively you can specify the algorithm file manually here.
- Dataset: Optional JSON file for input data
- Results Folder: Where computation results will be saved

2. **Start Compute Job**
- Select algorithm file (automatically detects open .js or .py files)
- Configure compute environment
- Select results folder location
- Start and monitor compute-to-data jobs
![Ocean Protocol VSCode Extension](./screenshots/setup-screenshot.png)

### Basic Operations
## Development & Contributing

#### Starting a Compute Job
Refer to the project structure and available scripts for local development. Contributions are always welcome—please check our guidelines in the repository.

1. Navigate to the "Start Compute Job" section
2. Your currently open JavaScript or Python file will be automatically selected as the algorithm
3. Select a results folder for computation output
4. Enter the compute environment URL
5. Click "Start Compute Job"
### Prerequisites

## Development
- Node.js (version specified in `.nvmrc`)
- VSCode version 1.93.0 or higher
- Git

### Project Structure
### Running the Extension Locally

```
ocean-protocol-vscode/
├── src/
│ ├── extension.ts # Main extension entry point
│ ├── viewProvider.ts # WebView UI provider
│ └── helpers/ # Helper functions
│ └── compute.ts # Compute job functionality
├── test/ # Test files
└── package.json # Project configuration
```
1. Clone the repository:

### Available Scripts
```bash
git clone https://github.com/your-username/ocean-protocol-vscode
cd ocean-protocol-vscode
```

- `npm run compile`: Compile the TypeScript code
- `npm run watch`: Compile in watch mode
- `npm run lint`: Run ESLint
- `npm run test`: Run tests
- `npm run package`: Create VSIX package for distribution
2. Install dependencies:

## Contributing
```bash
npm install
```

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
3. Build the extension:

```bash
npm run compile
```

4. Open in VSCode:
- Press F5 to start debugging. This will open a new VSCode window with the extension loaded.

## License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.

## Contact

Expand Down
Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading