{"id":50013665,"url":"https://github.com/profiq/docgen","last_synced_at":"2026-05-20T02:57:33.386Z","repository":{"id":145853978,"uuid":"616896314","full_name":"profiq/docgen","owner":"profiq","description":"IntelliJ plugin to generate Python documentation using OpenAI's GPT model","archived":false,"fork":false,"pushed_at":"2024-10-11T14:35:07.000Z","size":115,"stargazers_count":2,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-28T16:52:09.726Z","etag":null,"topics":["chatgpt","intellij-plugin","pycharm","pycharm-plugin","python"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/profiq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-21T09:58:50.000Z","updated_at":"2024-10-11T14:35:12.000Z","dependencies_parsed_at":"2024-04-02T10:30:55.745Z","dependency_job_id":"ee3a2050-d901-4949-baaa-c311ec0535b6","html_url":"https://github.com/profiq/docgen","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/profiq/docgen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profiq%2Fdocgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profiq%2Fdocgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profiq%2Fdocgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profiq%2Fdocgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/profiq","download_url":"https://codeload.github.com/profiq/docgen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profiq%2Fdocgen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33243960,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-19T15:49:41.270Z","status":"online","status_checked_at":"2026-05-20T02:00:07.149Z","response_time":356,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatgpt","intellij-plugin","pycharm","pycharm-plugin","python"],"created_at":"2026-05-20T02:57:29.666Z","updated_at":"2026-05-20T02:57:33.378Z","avatar_url":"https://github.com/profiq.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"Docgen\n==========================\n\nThis IntelliJ plugin allows you to generate Python function documentation using OpenAI's ChatGPT.  \nYou can download the plugin from the JetBrains MarketPlace - [Docgen](https://plugins.jetbrains.com/plugin/21294-docgen)\n\nFeatures\n--------\n\n*   Generate code documentation using OpenAI's models\n*   Option to use a custom prompt\n\nInstallation\n------------\n\n1.  Open IntelliJ IDEA\n2.  Make sure that the [Python plugin](https://plugins.jetbrains.com/plugin/7322-python-community-edition) is installed\n3.  Go to `Preferences`\n4.  Select `Plugins`\n5.  Click on `Marketplace` and search for `Docgen`\n6.  Install the plugin and restart IntelliJ IDEA\n\nConfiguration\n-------------\n\n1.  To set your OpenAI API key, go to `Preferences \u003e Tools  \u003e Docgen`\n2.  Enter your API key in the provided input field and click 'Apply'\n3.  Set your keyboard shortcut: go to `Preferences \u003e Keymap` and look for `Plugins \u003e Docgen \u003e Generate Docstring`\n\nUsage\n-----\n\n1.  Right-click on the function you want to generate documentation for\n2.  Choose `Generate Docstring` from the context menu\n3.  Wait for the OpenAI model to generate the documentation\n4.  The generated documentation will be displayed in a popup window\n5.  Click `Insert` to add the documentation to your Python function\n\nModel\n-----\n\nThe default model is `gpt-3.5-turbo`. To use another model go to `Preferences \u003e Tools \u003e Docgen` and\nenter the model name in the provided input field.\n\nPrompt\n------\n\nThe default prompt is:\n\n```css\nGenerate high-quality docstring for the following Python function including function signature:\n```\n\nTo use a custom prompt, go to `Preferences \u003e Tools \u003e Docgen` and enter your prompt in the provided input field.\n\nDevelopment environment\n-----------------------\n\nWe recommend using IntelliJ IDEA for development. After installing IDEA you can simply open the project folder.\n\nYou also need JDK 17. If IDEA can't find this JDK version on your machine it should\nsuggest downloading it for you after opening any `.java` file. You can also go to `File \u003e New \u003e Project \u003e JDK \u003e Add SDK` \nand download the correct JDK version manually.\n\nTo test the plugin you go to `Run \u003e Run...` and select the `Run Plugin` configuration. This will start a new isolated IDEA\ninstance with Docgen already installed.\n\nTo create a ZIP file for distributing the plugin first open the Gradle tool window by clicking `View \u003e Tool Windows \u003e Gradle`.\nThen select `Tasks \u003e intelij \u003e buildPlugin`. If the Gradle tool window is empty click the \"reload\" button. It will force\nIDEA to download all missing tools.\n\nContributing\n------------\n\nContributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofiq%2Fdocgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprofiq%2Fdocgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofiq%2Fdocgen/lists"}