jetbrains-plugin-server 0.0.1__py3-none-any.whl

jetbrains_plugin_server/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.0.1'

jetbrains_plugin_server/config.py

@@ -0,0 +1,20 @@
+import os
+from pathlib import Path
+
+DL_URL_BASE = os.getenv("DL_URL_BASE", "https://fake.url/{plugin_version_id}")
+
+JETBRAINS_PLUGINS_HOST = "https://plugins.jetbrains.com"
+
+LOCAL = Path(__file__).parent.parent.joinpath("local")
+
+PLUGIN_PROD_DATA = Path(__file__).parent.parent.joinpath("plugins_prod.json")
+
+PLUGIN_TEST_DATA = Path(__file__).parent.parent.joinpath("tests", "data", "plugins_test.json")
+
+PLUGIN_SPECS_DIR = "plugin_specs"
+PLUGIN_VERSIONS_DIR = "plugin_versions"
+PLUGINS_DIR = "plugins"
+
+IS_TEST_MODE = os.getenv("TEST_MODE") == "true"
+
+FAST_API_OFFLINE = os.getenv("FAST_API_OFFLINE") == "true"

jetbrains_plugin_server/model/data_listing.py

@@ -0,0 +1,50 @@
+from abc import ABC, abstractmethod
+from pathlib import Path
+from typing import Any
+
+import requests
+
+
+class DataListing(ABC):
+    @abstractmethod
+    def list(self, directory) -> list[str]:
+        raise NotImplementedError()
+
+    @abstractmethod
+    def get(self, directory, file) -> Any:
+        raise NotImplementedError()
+
+
+class FSDataListing(DataListing):
+
+    def __init__(self, base_path: str | Path):
+        self.base_path = Path(base_path)
+
+    def list(self, directory) -> list[str]:
+        return [
+            p.name
+            for p in self.base_path.joinpath(directory).glob("*")
+        ]
+
+    def get(self, directory, file) -> Any:
+        return self.base_path.joinpath(directory, file).read_text(encoding="utf8")
+
+
+class ArtifactoryDataListing(DataListing):
+
+    def __init__(self, base_url: str, repo_name: str):
+        self.base_url = base_url.strip("/")
+        self.repo_name = repo_name.strip("/")
+
+    def list(self, directory) -> list[str]:
+        url = f"{self.base_url}/artifactory/api/storage/{self.repo_name}/{directory}"
+        files_rep = requests.get(url)
+        files = files_rep.json()
+        return [
+            Path(file["uri"]).name
+            for file in files["children"]
+        ]
+
+    def get(self, directory, file) -> Any:
+        url = f"{self.base_url}/artifactory/{self.repo_name}/{directory}/{file}"
+        return requests.get(url).text

jetbrains_plugin_server/plugin_catalog.py

@@ -0,0 +1,18 @@
+import json
+import logging
+from functools import lru_cache
+
+from jetbrains_plugin_server.config import PLUGIN_TEST_DATA, IS_TEST_MODE, PLUGIN_PROD_DATA
+from jetbrains_plugin_server.schemas import CatalogSchema
+
+LOG = logging.getLogger(__name__)
+
+
+@lru_cache()
+def get_plugin_catalog() -> CatalogSchema:
+    LOG.info("load catalog from file")
+    if IS_TEST_MODE:
+        catalog_path = PLUGIN_TEST_DATA
+    else:
+        catalog_path = PLUGIN_PROD_DATA
+    return CatalogSchema.model_validate(json.loads(catalog_path.read_text()))

jetbrains_plugin_server/plugin_model.py

@@ -0,0 +1,35 @@
+from pydantic_extra_types.semantic_version import SemanticVersion
+
+from jetbrains_plugin_server.plugin_catalog import get_plugin_catalog
+from jetbrains_plugin_server.schemas import PluginVersionSchema, LowPaddingSemanticVersion
+
+
+def get_plugins(build: str) -> list[tuple[str, PluginVersionSchema]]:
+    catalog = get_plugin_catalog()
+    build_version = LowPaddingSemanticVersion.parse(build)
+    return [
+        (plugin.name, version_found)
+        for plugin in catalog.plugins
+        if (version_found := get_latest_compatible(build_version, plugin.versions))
+    ]
+
+
+def get_latest_compatible(
+        build_version: SemanticVersion,
+        plugin_versions: list[PluginVersionSchema]
+):
+    for plugin_version in plugin_versions:
+        if is_compatible(build_version, plugin_version):
+            return plugin_version
+
+    return None
+
+
+def is_compatible(
+        build_version: SemanticVersion,
+        plugin_version: PluginVersionSchema
+) -> bool:
+    since, until = plugin_version.specs.since_build_semver, plugin_version.specs.until_build_semver
+    if until:
+        return since <= build_version <= until
+    return since <= build_version

jetbrains_plugin_server/schemas.py

@@ -0,0 +1,63 @@
+import re
+from typing import Literal, Type, Any
+
+from pydantic import BaseModel, Field, model_validator
+from pydantic_extra_types.semantic_version import SemanticVersion
+from semver._types import String
+from semver.version import T
+
+
+class LowPaddingSemanticVersion:
+    @staticmethod
+    def parse(version: str) -> SemanticVersion:
+        return SemanticVersion.parse(normalize_version(version, "start"))
+
+
+class HighPaddingSemanticVersion:
+    @staticmethod
+    def parse(version: str) -> SemanticVersion:
+        return SemanticVersion.parse(normalize_version(version, "end"))
+
+
+def normalize_version(value: str, mode: Literal["start", "end"]):
+    if match := re.match(r"^[A-Z]+-(.+)$", value):
+        value = match.group(1)
+    replacer = "0" if mode == "start" else "999999"
+    result = value.replace(".*", f".{replacer}")
+    while result.count(".") < 2:
+        result += f".{replacer}"
+    return result
+
+
+class PluginVersionSpecSchema(BaseModel):
+    since_build: str = Field(alias="since-build")
+    until_build: str | None = Field(alias="until-build", default=None)
+
+    since_build_semver: SemanticVersion = Field(alias="since-build-semver")
+    until_build_semver: SemanticVersion | None = Field(alias="until-build-semver", default=None)
+
+    @model_validator(mode='before')
+    @classmethod
+    def set_semver_fields(cls, data: Any) -> Any:
+        data["since-build-semver"] = LowPaddingSemanticVersion.parse(data["since-build"])
+        if ub := data.get("until-build"):
+            data["until-build-semver"] = HighPaddingSemanticVersion.parse(ub)
+        return data
+
+
+class PluginVersionSchema(BaseModel):
+    plugin_id: str
+    plugin_version_id: int
+    description: str | None
+    change_notes: str | None
+    version: str
+    specs: PluginVersionSpecSchema
+
+
+class PluginSchema(BaseModel):
+    name: str
+    versions: list[PluginVersionSchema]
+
+
+class CatalogSchema(BaseModel):
+    plugins: list[PluginSchema] = Field(default_factory=list)

jetbrains_plugin_server/server.py

@@ -0,0 +1,41 @@
+import logging
+from pathlib import Path
+from typing import Annotated
+
+import markdown
+
+from jetbrains_plugin_server.config import FAST_API_OFFLINE
+
+if FAST_API_OFFLINE:
+    from fastapi_offline import FastAPIOffline as FastAPI
+else:
+    from fastapi import FastAPI  # type: ignore
+
+from fastapi.responses import HTMLResponse, Response
+
+from jetbrains_plugin_server.plugin_catalog import get_plugin_catalog
+from jetbrains_plugin_server.plugin_model import get_plugins
+from jetbrains_plugin_server.to_xml import to_xml
+
+LOG = logging.getLogger(__name__)
+
+
+def create_app():
+    app = FastAPI()
+
+    @app.get("/")
+    def get_plugins_route(build: Annotated[
+        str, "IDE build number to filter the available plugins and return only the compatible ones"] = ""):
+        if not build:
+            md = Path(__file__).parent.parent.joinpath("README.md").read_text()
+            return HTMLResponse(content=markdown.markdown(md))
+
+        LOG.debug("Request with build=%s", build)
+        result = get_plugins(build)
+        return Response(content=to_xml(result), media_type="application/xml")
+
+    @app.get("/cache")
+    def get_cache_route():
+        return get_plugin_catalog()
+
+    return app

jetbrains_plugin_server/to_xml.py

@@ -0,0 +1,29 @@
+import xml.etree.ElementTree as ET
+from io import BytesIO
+
+from jetbrains_plugin_server.config import DL_URL_BASE
+from jetbrains_plugin_server.schemas import PluginVersionSchema
+
+
+def to_xml(plugins: list[tuple[str, PluginVersionSchema]]):
+    a = ET.Element('plugins')
+    for name, plugin in plugins:
+        p = ET.SubElement(a, 'plugin', {
+            "id": plugin.plugin_id,
+            # url of download
+            "url": DL_URL_BASE.format(plugin_version_id=plugin.plugin_version_id),
+            "version": plugin.version
+        })
+        attrs = {"since-build": plugin.specs.since_build}
+        if ub := plugin.specs.until_build:
+            attrs["until-build"] = ub
+        iv = ET.SubElement(p, 'idea-version', attrs)
+
+        ET.SubElement(p, 'name').text = name
+        ET.SubElement(p, 'description').text = plugin.description
+        ET.SubElement(p, 'change-notes').text = plugin.change_notes
+
+    bio = BytesIO()
+    ET.ElementTree(a).write(bio)
+    bio.seek(0)
+    return b"<?xml version='1.0' encoding='UTF-8'?>" + bio.read()

jetbrains_plugin_server/tools/dl_data.py

@@ -0,0 +1,55 @@
+from requests import get, Session
+from requests.adapters import HTTPAdapter, Retry
+
+from jetbrains_plugin_server.config import PLUGINS_DIR, PLUGIN_VERSIONS_DIR, PLUGIN_SPECS_DIR, LOCAL, \
+    JETBRAINS_PLUGINS_HOST
+
+PLUGINS: list[str] = [
+    "https://plugins.jetbrains.com/plugin/631-python",
+    "https://plugins.jetbrains.com/plugin/10080-rainbow-brackets",
+    "https://plugins.jetbrains.com/plugin/11938-one-dark-theme",
+    "https://plugins.jetbrains.com/plugin/9525--env-files",
+    "https://plugins.jetbrains.com/plugin/11938-one-dark-theme",
+    "https://plugins.jetbrains.com/plugin/15075-jpa-buddy",
+    "https://plugins.jetbrains.com/plugin/9525--env-files-support/",
+    "https://plugins.jetbrains.com/plugin/10044-atom-material-icons/",
+    "https://plugins.jetbrains.com/plugin/164-ideavim",
+    "https://plugins.jetbrains.com/plugin/9792-key-promoter-x",
+    "https://plugins.jetbrains.com/plugin/14708-mario-progress-bar",
+    "https://plugins.jetbrains.com/plugin/7086-acejump"
+]
+
+if __name__ == '__main__':
+    s = Session()
+    retries = Retry(total=5, backoff_factor=0.1)
+    s.mount('https://', HTTPAdapter(max_retries=retries))
+
+    for plugin in PLUGINS:
+        print("PLUGIN", plugin)
+        plugin = plugin.replace(f"{JETBRAINS_PLUGINS_HOST}/plugin/", "").strip("/")
+        plugin_id_int = plugin.split("-", maxsplit=1)[0]
+
+        versions_rep = get(f"{JETBRAINS_PLUGINS_HOST}/plugins/list?pluginId={plugin}")
+        LOCAL.joinpath(PLUGIN_SPECS_DIR, f"{plugin_id_int}.xml").write_bytes(
+            versions_rep.content
+        )
+
+        versions_id_rep = get(f"{JETBRAINS_PLUGINS_HOST}/api/plugins/{plugin_id_int}/updateVersions")
+        LOCAL.joinpath(PLUGIN_VERSIONS_DIR, f"{plugin_id_int}.json").write_bytes(
+            versions_id_rep.content
+        )
+
+        for row in versions_id_rep.json()[:-4:-1]:
+            print("   VERSION", row["version"])
+            plugin_version_id = row["id"]
+            dl = s.get(
+                f"{JETBRAINS_PLUGINS_HOST}/plugin/download",
+                params={"updateId": plugin_version_id},
+                stream=True
+            )
+
+            print("   Done in ", dl.elapsed)
+
+            LOCAL.joinpath(PLUGINS_DIR, f"{plugin_version_id}.zip").write_bytes(
+                dl.content
+            )

jetbrains_plugin_server/tools/gen_json_cache.py

@@ -0,0 +1,71 @@
+import json
+import logging
+import xml.etree.ElementTree as ET
+from typing import cast
+
+from jetbrains_plugin_server.config import PLUGIN_TEST_DATA, PLUGIN_SPECS_DIR, PLUGIN_VERSIONS_DIR, \
+    PLUGIN_PROD_DATA, IS_TEST_MODE, \
+    PLUGINS_DIR
+from jetbrains_plugin_server.model.data_listing import DataListing
+from jetbrains_plugin_server.schemas import CatalogSchema, PluginSchema, PluginVersionSchema, \
+    PluginVersionSpecSchema
+
+LOG = logging.getLogger(__name__)
+
+
+def gen_json_cache(dl: DataListing, only_available_plugins: bool = True):
+    """
+    dl = ArtifactoryDataListing("https://...", "jetbrains/plugin-server")
+    dl = FSDataListing(LOCAL)
+
+    gen_json_cache(dl)
+    """
+    LOG.info("build catalog")
+
+    result: CatalogSchema = CatalogSchema()
+
+    available_plugins = [int(p.split(".", maxsplit=1)[0]) for p in dl.list(PLUGINS_DIR)]
+
+    for plugin in dl.list(PLUGIN_SPECS_DIR):
+        plugin_id_int = plugin.split(".", maxsplit=1)[0]
+
+        versions_to_plugin_version_id = {
+            row["version"]: row["id"]
+            for row in json.loads(dl.get(PLUGIN_VERSIONS_DIR, f"{plugin_id_int}.json"))
+        }
+
+        plugin_spec = dl.get(PLUGIN_SPECS_DIR, plugin)
+
+        root = ET.fromstring(plugin_spec)
+
+        if not (category := root.find("category")):
+            LOG.error("Plugin %s has no category", plugin)
+            continue
+
+        versions = category.findall("idea-plugin")
+
+        result.plugins.append(PluginSchema(
+            name=versions[0].find("name").text,
+            versions=[
+                PluginVersionSchema(
+                    plugin_id=version.find("id").text,
+                    plugin_version_id=versions_to_plugin_version_id[version.find("version").text],
+                    version=version.find("version").text or "",
+                    specs=PluginVersionSpecSchema(
+                        **{cast(str, k): v for k, v in version.find("idea-version").items() if v != "n/a"}
+                    ),
+                    description=version.find("description").text,
+                    change_notes=version.find("change-notes").text,
+                )
+                for version in versions
+                if not only_available_plugins or
+                   versions_to_plugin_version_id[version.find("version").text] in available_plugins
+            ]
+        ))
+        LOG.info("Plugin '%s' (%s) found %s versions but only %s had available zip",
+                 versions[0].find("name").text, plugin, len(versions), len(result.plugins[-1].versions))
+
+    if IS_TEST_MODE:
+        PLUGIN_TEST_DATA.write_text(json.dumps(result.model_dump(mode="json", by_alias=True), indent=4))
+    else:
+        PLUGIN_PROD_DATA.write_text(json.dumps(result.model_dump(mode="json", by_alias=True), indent=4))

jetbrains_plugin_server-0.0.1.dist-info/METADATA

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: jetbrains-plugin-server
+Version: 0.0.1
+Summary: A server to serve jetbrains plugins
+Author-email: azro352 <35503478+azro352@users.noreply.github.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/azro352/jetbrains-plugin-server.git
+Project-URL: Bug Tracker, https://github.com/azro352/jetbrains-plugin-server/issues
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: fastapi~=0.115.12
+Requires-Dist: markdown~=3.8
+Requires-Dist: parameterized~=0.9.0
+Requires-Dist: pydantic~=2.11.3
+Requires-Dist: pydantic-extra-types[semver]~=2.10.3
+Requires-Dist: requests~=2.32.3
+Requires-Dist: semver~=3.0.4
+Requires-Dist: uvicorn
+Provides-Extra: offline
+Requires-Dist: fastapi_offline; extra == "offline"
+Dynamic: license-file
+
+<!--
+
+THIS README FILE IS RENDERED ON '/' ENDPOINT WHEN NO "build" ARG IS GIVEN
+
+-->
+
+# jetbrains-plugin-server
+
+Creates a jetbrains-compatible plugin server with a given list of plugins
+
+## Tools
+
+- `src/tools/dl_data.py` to fetch plugins specifications, versions and content from jetbrains to a local filesystem
+- `src/tools/gen_json_cache.py` to build a JSON cache to answer faster, using either a filesystem storage or an
+  artifactory

jetbrains_plugin_server-0.0.1.dist-info/RECORD

@@ -0,0 +1,17 @@
+jetbrains_plugin_server/__init__.py,sha256=DsAHdxLC16H2VjdFOU5tBx2xT9VnNQ-XbTS24fRCa_w,22
+jetbrains_plugin_server/config.py,sha256=g684QHR0SnHADEKC6EuWWUIXPqthr1wNw83uciMvP3o,612
+jetbrains_plugin_server/plugin_catalog.py,sha256=k8Lfd-77JBll39JE4H4q6U3KO9FHTFB2yfAnqRcTglw,531
+jetbrains_plugin_server/plugin_model.py,sha256=_8qVxqTPxQUaYvLDp7Or85kZI1NdCX8JnP3j358vYj4,1157
+jetbrains_plugin_server/schemas.py,sha256=mYlyIidhAYpafmRn0M1j4ouNQNgGZZtgARsbwL66nuM,1967
+jetbrains_plugin_server/server.py,sha256=zQlnoP_qOOn4meYBPu4SDy4xXiBJKvxLABan88tFBPo,1196
+jetbrains_plugin_server/to_xml.py,sha256=k-TAxtFOhA3MKJd45gRVoXE_Sle2F4HgTwFhKHCyy7I,1050
+jetbrains_plugin_server/model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jetbrains_plugin_server/model/data_listing.py,sha256=dVGnqgz4RP-ZjSKLOOtsxeMKcAZH23mFnzDtXWQB-Vo,1396
+jetbrains_plugin_server/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jetbrains_plugin_server/tools/dl_data.py,sha256=e-TqKTxQxcDZkdDIFGJs1eprbNoJ_Z44pxHNLMjFDz8,2286
+jetbrains_plugin_server/tools/gen_json_cache.py,sha256=UvRQ3R6TEpb-g2fCZLqd1RMKSNvCCuKg_s0wfpQUD7s,2770
+jetbrains_plugin_server-0.0.1.dist-info/licenses/LICENSE.md,sha256=tAj5NBpLsYCAvvYJNxPPffRCtXvdbDEihvwpVFdB_rw,1064
+jetbrains_plugin_server-0.0.1.dist-info/METADATA,sha256=Tu7dce-Ms1fqYG9JLIvBmMMnpaunQryoEEpyEEtCAXc,1542
+jetbrains_plugin_server-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+jetbrains_plugin_server-0.0.1.dist-info/top_level.txt,sha256=r7ESDf8AgP-KTE2kmXknIAY3bf_BPQ-YohWCZO4wKpo,24
+jetbrains_plugin_server-0.0.1.dist-info/RECORD,,

jetbrains_plugin_server-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

jetbrains_plugin_server-0.0.1.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 azro352
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

jetbrains_plugin_server-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+jetbrains_plugin_server