{"id":35210050,"url":"https://github.com/opengeos/qgis-notebook-plugin","last_synced_at":"2026-04-07T13:32:14.341Z","repository":{"id":330464399,"uuid":"1122813915","full_name":"opengeos/qgis-notebook-plugin","owner":"opengeos","description":"A QGIS plugin for running Jupyter Notebook within QGIS","archived":false,"fork":false,"pushed_at":"2026-03-16T20:38:53.000Z","size":96,"stargazers_count":92,"open_issues_count":1,"forks_count":8,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-03-17T07:30:09.580Z","etag":null,"topics":["geospatial","jupyter-notebook","python","qgis","qgis-plugin"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opengeos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-25T15:11:47.000Z","updated_at":"2026-03-02T15:45:42.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/opengeos/qgis-notebook-plugin","commit_stats":null,"previous_names":["opengeos/qgis-notebook-plugin"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/opengeos/qgis-notebook-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opengeos%2Fqgis-notebook-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opengeos%2Fqgis-notebook-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opengeos%2Fqgis-notebook-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opengeos%2Fqgis-notebook-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opengeos","download_url":"https://codeload.github.com/opengeos/qgis-notebook-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opengeos%2Fqgis-notebook-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31515144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["geospatial","jupyter-notebook","python","qgis","qgis-plugin"],"created_at":"2025-12-29T17:31:43.646Z","updated_at":"2026-04-07T13:32:14.335Z","avatar_url":"https://github.com/opengeos.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QGIS Notebook Plugin\n\nA QGIS plugin for rendering and running Jupyter notebooks directly within QGIS. The plugin provides a dockable panel interface for interactive notebook execution.\n\n[![QGIS Plugin](https://img.shields.io/badge/QGIS-Plugin-green.svg)](https://plugins.qgis.org/plugins/qgis_notebook)\n![License](https://img.shields.io/badge/License-MIT-blue.svg)\n\n## Features\n\n- **📂 Open Notebooks**: Load and render Jupyter notebook (.ipynb) files\n- **▶️ Execute Cells**: Run Python code cells with syntax highlighting\n- **📝 Markdown Support**: Render markdown cells with headers, lists, links, and formatting\n- **🎨 Syntax Highlighting**: Beautiful Python syntax highlighting for code cells\n- **📊 Rich Output**: View text, errors, and execution results\n- **🔄 QGIS Integration**: Access QGIS layers, projects, and Python environment\n- **💾 Save Notebooks**: Save changes back to notebook files\n- **📄 Create New**: Start fresh notebooks from within QGIS\n- **⚙️ Customizable**: Configure appearance, fonts, and execution settings\n- **🔄 Auto-Update**: Check for and install updates from GitHub\n\n## Screenshots\n\nThe plugin provides a clean, dark-themed interface that integrates seamlessly with QGIS:\n\n- **Notebook Panel**: Dockable panel for viewing and executing notebooks\n- **Settings Panel**: Configure plugin behavior and appearance\n- **Update Checker**: Keep the plugin up-to-date\n\n### Notebook Panel\n\n![](https://github.com/user-attachments/assets/104b8a54-d693-40e8-b4fd-fa8d69b0c655)\n\n### Settings Panel\n\n![](https://github.com/user-attachments/assets/a812876d-0f2a-4d84-8ac6-6764f38abf77)\n\n### Update Checker\n\n![](https://github.com/user-attachments/assets/9addca25-c9b0-49f6-b19a-4d4aaf92d5fa)\n\n\n## Video Tutorial\n\n👉 [Run Jupyter Notebooks Directly Inside QGIS! | QGIS Notebook Plugin Tutorial](https://youtu.be/Nr2QEZq2Q_Q)\n\n[![QGIS Notebook Plugin](https://github.com/user-attachments/assets/ca52a874-f920-45cb-980d-f77006f3f2fd)](https://youtu.be/Nr2QEZq2Q_Q)\n\n## Installation\n\n### From QGIS Plugin Manager (Recommended)\n\n1. Open QGIS\n2. Go to **Plugins** → **Manage and Install Plugins...**\n3. Go to the **Settings** tab\n4. Click **Add...** under \"Plugin Repositories\"\n5. Give a name for the repository, e.g., \"OpenGeos\"\n6. Enter the URL of the repository: https://qgis.gishub.org/plugins.xml\n7. Click **OK**\n8. Go to the **All** tab\n9. Search for \"Notebook\"\n10. Select \"Notebook\" from the list and click **Install Plugin**\n\n### Using Installation Scripts\n\n#### Python Script (Cross-platform)\n\nClone the repository:\n\n```bash\ngit clone https://github.com/opengeos/qgis-notebook-plugin.git\ncd qgis-notebook-plugin\n```\n\nInstall the plugin:\n\n```bash\n# Install the plugin\npython install.py\n\n# Remove the plugin\npython install.py --remove\n```\n\n#### Shell Script (Linux/macOS)\n\n```bash\n# Install the plugin\n./install.sh\n\n# Remove the plugin\n./install.sh --remove\n\n# Show help\n./install.sh --help\n```\n\n### Manual Installation\n\n1. Download the latest release from \u003chttps://qgis.gishub.org\u003e.\n2. Extract the zip file\n3. Copy the `qgis_notebook` folder to your QGIS plugins directory:\n   - **Linux**: `~/.local/share/QGIS/QGIS3/profiles/default/python/plugins/`\n   - **Windows**: `%APPDATA%\\QGIS\\QGIS3\\profiles\\default\\python\\plugins\\`\n   - **macOS**: `~/Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins/`\n4. Restart QGIS\n5. Enable the plugin in **Plugins** → **Manage and Install Plugins...**\n\n## Usage\n\n### Opening a Notebook\n\n1. Click the **📂 Open** button in the toolbar\n2. Navigate to and select a `.ipynb` file\n3. The notebook will be rendered in the panel\n\n### Running Code Cells\n\n1. Click the **▶ Run** button on any code cell to execute it\n2. Use **▶▶ Run All** to execute all cells in order\n3. View output directly below each cell\n\n### Creating a New Notebook\n\n1. Click the **📄 New** button\n2. Start adding code and markdown cells\n3. Save with **💾 Save**\n\n### Changing Cell Type\n\nClick the **CODE** or **MARKDOWN** badge in the cell header to switch between code and markdown cell types.\n\n### Context Menu (Right-Click)\n\nRight-click on any cell to access:\n- **Add Code/Markdown Cell Above/Below**\n- **Clear Output** (code cells only)\n- **Convert to Markdown/Code**\n- **Split Cell at Cursor** — splits the cell into two at the current cursor position\n- **Delete Cell**\n\n### Keyboard Shortcuts\n\nThe plugin supports JupyterLab-style keyboard shortcuts for efficient notebook editing.\n\n#### Edit Mode (while editing a cell)\n\n| Shortcut | Action |\n|----------|--------|\n| `Ctrl+Enter` | Execute current cell |\n| `Shift+Enter` | Execute cell and move to next |\n| `Alt+Enter` | Execute cell and insert new cell below |\n| `Ctrl+Space` | Trigger autocomplete |\n\n#### Command Mode (cell selected, not editing)\n\nTo enter command mode, click outside the text editor area of a cell (e.g., on the cell border or header).\n\n| Shortcut | Action |\n|----------|--------|\n| `A` | Insert code cell above |\n| `B` | Insert code cell below |\n| `X` | Cut selected cell |\n| `D, D` | Delete selected cell (press D twice) |\n| `Y` | Change cell type to Code |\n| `M` | Change cell type to Markdown |\n\n#### Any Mode (works in both edit and command mode)\n\n| Shortcut | Action |\n|----------|--------|\n| `Ctrl+Shift+Up` | Move cell up |\n| `Ctrl+Shift+Down` | Move cell down |\n| `Ctrl+Shift+-` | Split cell at cursor position |\n\n## Configuration\n\nAccess settings via the **Settings** button in the toolbar:\n\n### General Settings\n- Auto-save notebooks\n- Show line numbers\n- Word wrap in cells\n\n### Execution Settings\n- Execution timeout\n- Clear outputs before run\n- Stop on error\n- Pre-import modules (QGIS, os, sys, numpy, pandas)\n\n### Appearance Settings\n- Color scheme\n- Code font family\n- Font size\n- Line height\n- Cell spacing\n\n## QGIS Integration\n\nThe plugin automatically imports QGIS modules, making it easy to work with your project:\n\n```python\n# Access the current project\nfrom qgis.core import QgsProject\nproject = QgsProject.instance()\n\n# List all layers\nfor layer in project.mapLayers().values():\n    print(layer.name())\n\n# Access the map canvas\nfrom qgis.utils import iface\ncanvas = iface.mapCanvas()\n```\n\n## Requirements\n\n- QGIS 3.28 or later\n- Python 3.10 or later (included with QGIS)\n\n## Update Checker\n\nThe plugin includes a built-in update checker that can:\n- Check for new versions from GitHub\n- Display changelog information\n- Download and install updates automatically\n\nAccess it via **Notebook** → **Check for Updates...**\n\n## About Dialog\n\nThe About dialog displays:\n- Current plugin version\n- Author information\n- Feature list\n- Links to GitHub repository and issue tracker\n\nAccess it via **Notebook** → **About QGIS Notebook**\n\n## Development\n\n### Packaging for Distribution\n\n#### Python Script\n\n```bash\n# Create a zip file for distribution\npython package_plugin.py\n\n# Create without version in filename\npython package_plugin.py --no-version\n\n# Custom output path\npython package_plugin.py --output /path/to/output.zip\n```\n\n#### Shell Script\n\n```bash\n# Create a zip file for distribution\n./package_plugin.sh\n\n# Create without version in filename\n./package_plugin.sh --no-version\n\n# Show help\n./package_plugin.sh --help\n```\n\nThe packaged zip file can be uploaded to the [QGIS Plugin Repository](https://plugins.qgis.org/).\n\n### Project Structure\n\n```\nqgis-notebook-plugin/\n├── install.py                # Cross-platform installation script\n├── install.sh                # Shell installation script (Linux/macOS)\n├── package_plugin.py         # Cross-platform packaging script\n├── package_plugin.sh         # Shell packaging script (Linux/macOS)\n├── README.md                 # This file\n├── LICENSE                   # MIT License\n└── qgis_notebook/            # Main plugin directory\n    ├── __init__.py           # Plugin entry point\n    ├── qgis_notebook.py      # Main plugin class\n    ├── metadata.txt          # Plugin metadata\n    ├── LICENSE               # Plugin license\n    ├── dialogs/\n    │   ├── __init__.py\n    │   ├── notebook_dock.py  # Main notebook dock widget\n    │   ├── settings_dock.py  # Settings panel\n    │   └── update_checker.py # Update checker dialog\n    └── icons/\n        ├── icon.svg          # Main plugin icon\n        ├── settings.svg      # Settings icon\n        └── about.svg         # About icon\n```\n\n### Building\n\nTo package the plugin for distribution, use the provided scripts:\n\n```bash\ncd qgis-notebook-plugin\n\n# Using Python (cross-platform)\npython package_plugin.py\n\n# Using shell script (Linux/macOS)\n./package_plugin.sh\n\n# Or manually\nzip -r qgis_notebook.zip qgis_notebook/\n```\n\nThe output will be a file like `qgis_notebook-0.1.0.zip` ready for distribution.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Changelog\n\n### 0.3.0\n- Fix line spacing issue on Linux\n\n### 0.2.0\n- Add support for light theme\n- Add support for clearing output of a code cell\n- Add support for inserting code snippets into a notebook\n\n### 0.1.0 (Initial Release)\n- Basic notebook rendering and execution\n- Dockable panel interface\n- Python syntax highlighting\n- Markdown cell rendering\n- Settings panel for configuration\n- Update checker functionality\n- QGIS module integration\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopengeos%2Fqgis-notebook-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopengeos%2Fqgis-notebook-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopengeos%2Fqgis-notebook-plugin/lists"}