Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.21 KB

README.md

File metadata and controls

56 lines (39 loc) · 1.21 KB
Raw

About

This is a catalog software for negotiating between an Eclipse-based program and a wiki-like software that contains additional information about the plugins to be installed.

API

The Eclipse marketplace API is documented at https://wiki.eclipse.org/Marketplace/REST

Adding Plugins to the TextGridLab marketplace

Plugins are located in etc/data.yaml, to add a new plugin you may create a pull request for data.yaml.

The following template could be used:

- !PlugIn
  plugId:
  name:
  category:
  pageId:
  featured:
  installableUnit:
  owner:
  company:
  company_url:
  update_url:
  human_title:
  description: |
    fill a description here
  logo:
  license:
  screenshot:

Required fields are: name, installableUnit, update_url, human_title, description and license. The plugin id (plugId) needs to be unique.

Develop and Test

Run locally (for development)

    docker-compose build
    docker-compose up

Then point your browser to localhost:5000, e.g: http://localhost:5000/marketplace/featured/api/p

Check the API docs: http://localhost:5000/marketplace/docs or http://localhost:5000/marketplace/redoc

Pytest:

    docker-compose exec web python -m pytest .