jetbrains-plugin-server 0.2.2

A server to serve jetbrains plugins

Creates a jetbrains-compatible plugin server with a given list of plugins

How-to use

Download the data

Use the script dl_data.py to fetch plugins metadata and data from jetbrains server, and save them where you want

Create the server

from fastapi import FastAPI

from jetbrains_plugin_server import create_plugin_server
from jetbrains_plugin_server.model.data_listing import FSDataListing

app: FastAPI = create_plugin_server(
    FSDataListing("/data/myfolder"),
    "https://myendpoint/plugins/{plugin_version_id}"
)

Then deploy it like you want

Use the server

Register the server in your IDE

• Press Ctrl+Alt+S to open settings and then select Plugins.
• On the Plugins page, click the Settings button and select Manage Plugin Repositories….
• In the Custom Plugin Repositories dialog, click Add icon and specify your repository URL
• Click OK in the Custom Plugin Repositories dialog to save the list of plugin repositories.
• Click OK in the Settings dialog to apply the changes.

Tools

To fetch plugins specifications, versions and content from jetbrains to a local filesystem

cat myfile.txt

jb_plugin_download myfile.txt

To build a JSON cache to answer faster, using either a filesystem storage, an artifactory or an apache server

from jetbrains_plugin_server.model.catalog import CatalogSchema

catalog = CatalogSchema(data_listing=dl)
catalog.build()

Paths

• / to get the readme OR the compliant xml content if url param build is provided
• /cache to get the full JSON cache of the server
• /packages to get a nicer view of the available packages
• /docs the openapi spec of the app, provided by FastAPI