{"id":34697585,"url":"https://github.com/allenporter/supernote-lite","last_synced_at":"2026-01-31T18:22:24.752Z","repository":{"id":322468171,"uuid":"1089612677","full_name":"allenporter/supernote-lite","owner":"allenporter","description":"All-in-one toolkit for Supernote devices: parse notebooks, self host, and access services.","archived":false,"fork":false,"pushed_at":"2026-01-18T05:59:33.000Z","size":905,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-18T15:55:27.732Z","etag":null,"topics":["self-hosted","supernote","supernote-planner"],"latest_commit_sha":null,"homepage":"https://allenporter.github.io/supernote-lite/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/allenporter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/security.md","support":null,"governance":null,"roadmap":"ROADMAP.md","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-11-04T15:21:27.000Z","updated_at":"2026-01-18T05:59:37.000Z","dependencies_parsed_at":"2026-01-01T07:00:21.407Z","dependency_job_id":null,"html_url":"https://github.com/allenporter/supernote-lite","commit_stats":null,"previous_names":["allenporter/supernote-lite"],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/allenporter/supernote-lite","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allenporter%2Fsupernote-lite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allenporter%2Fsupernote-lite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allenporter%2Fsupernote-lite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allenporter%2Fsupernote-lite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allenporter","download_url":"https://codeload.github.com/allenporter/supernote-lite/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allenporter%2Fsupernote-lite/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28733503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T17:51:25.893Z","status":"ssl_error","status_checked_at":"2026-01-24T17:50:48.377Z","response_time":89,"last_error":"SSL_read: 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":["self-hosted","supernote","supernote-planner"],"created_at":"2025-12-24T22:38:52.363Z","updated_at":"2026-01-24T18:07:33.335Z","avatar_url":"https://github.com/allenporter.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# supernote\n\nPersonal Knowledge Management Hub for Supernote: parse notebooks, self-host services, and unlock AI insights.\n\nThis content is shared between the [documentation](https://allenporter.github.io/supernote-lite/) and github repository at [github.com/allenporter/supernote-lite](https://github.com/allenporter/supernote-lite).\n\n## Features\n\n- **Notebook Parsing**: Convert `.note` files to PDF, PNG, SVG, or text\n- **AI-Powered Insights**: OCR, automated summarization, and key metadata extraction via Gemini API\n- **Supernote Private Server**: Self-hosted Supernote Private Cloud with robust background processing\n- **Developer API**: Interact with Supernote Cloud and local data through a modern async Python client\n- **System Maintenance**: Background polling, auto-recovery for stalled tasks, and storage quota management\n\n## AI \u0026 Automation\n\nSupernote-Lite transforms your handwritten notes into structured knowledge. When configured with a Gemini API key, the server automatically:\n\n- **OCR**: Transcribes handwriting with high accuracy.\n- **Summarization**: Generates concise summaries of your note journals.\n- **Entity Extraction**: Identifies dates, tasks, and key themes.\n- **Retrieval Support**: Chunks and indexes notes for efficient search (Experimental).\n\n## Installation\n\n```bash\n# Install specific components\npip install supernote              # Notebook parsing only\npip install supernote[server]      # + Private server \u0026 AI features\npip install supernote[client]      # + API Client\n\n# Full installation (recommended for server users)\npip install supernote[all]\n```\n\n## Local Development Setup\n\nTo set up the project for development, please refer to the [Contributing Guide](docs/CONTRIBUTING.md).\n\n## Quick Start\n\n### Start the AI-Powered Server\n\n1. **Bootstrap with Gemini**:\n   ```bash\n   export SUPERNOTE_GEMINI_API_KEY=\"your-api-key\"\n   supernote serve\n   ```\n\n2. **Register \u0026 Login**:\n   ```bash\n   # Add your first user (System Admin)\n   supernote admin --url http://localhost:8080 user add email@example.com\n\n   # Login via CLI\n   supernote cloud login email@example.com --url http://localhost:8080\n   supernote cloud ls\n   ```\n\nSee the [Bootstrap Guide](docs/bootstrap_guide.md) for detailed deployment and security instructions.\n\n### Parse a Notebook\n\n```python\nfrom supernote.notebook import parse_notebook\n\nnotebook = parse_notebook(\"mynote.note\")\nnotebook.to_pdf(\"output.pdf\")\n```\n\nThe notebook parser is a fork and slightly lighter dependency version of [supernote-tool](https://github.com/jya-dev/supernote-tool). All credit goes to the original authors for providing an amazing low-level utility.\n\n### Run with Docker\n\n```bash\n# Build \u0026 Run server\ndocker build -t supernote .\ndocker run -d -p 8080:8080 -v $(pwd)/storage:/storage supernote serve\n```\n\nSee [Server Documentation](https://github.com/allenporter/supernote-lite/blob/main/supernote/server/README.md) for details.\n\n### Developer API\n\nIntegrate Supernote into your own Python applications:\n\n```python\nfrom supernote.client import Supernote\n# See library docstrings for usage examples\n```\n\n\n## CLI Usage\n\n```bash\n# Server \u0026 Admin\nsupernote serve\nsupernote admin user list\n\n# Notebook operations\nsupernote notebook convert input.note output.pdf\nsupernote notebook analyze input.note\n\n# Cloud operations\nsupernote cloud login --url http://localhost:8080 email@example.com\nsupernote cloud ls\n```\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](docs/CONTRIBUTING.md) for details on:\n- Local development setup\n- Project architecture\n- Using **Ephemeral Mode** for fast testing\n- AI Skills for agentic interaction\n\n## Acknowledgments\n\nThis project is in support of the amazing [Ratta Supernote](https://supernote.com/) product and community. It aims to be a complementary, unofficial offering that is compatible with the [Private Cloud feature](https://support.supernote.com/Whats-New/setting-up-your-own-supernote-private-cloud-beta).\n\n### Comparison with Official Private Cloud\n\n| Feature | Official Private Cloud | Supernote-Lite (This Project) |\n|---------|------------------------|-------------------------------|\n| **Core AI** | No (Basic Sync) | **Yes** (OCR, Summaries, Insights) |\n| **System** | Java / Spring | Python (Asyncio) |\n| **Source** | Closed Source | Open Source |\n| **Flexibility** | Set-and-forget | High (Developer-friendly, CLI) |\n| **Hardware** | Docker Required | Python 3.13+ (Low resource) |\n| **Status** | Stable Product | Community Innovation |\n\n**Use the Official Private Cloud if:**\n- You want a supported, \"set-and-forget\" solution.\n- You prefer using Docker containers.\n\n**Use Supernote-Lite if:**\n- You want **AI insights** and OCR for your notes.\n- You want to integrate Supernote data into your local scripts or knowledge workflows.\n- You want to run on low-power hardware without Docker overhead.\n- You want full control over how your data is processed.\n\n## Community Projects\n\n- [jya-dev/supernote-tool](https://github.com/jya-dev/supernote-tool) - Original parser foundation.\n- [awesome-supernote](https://github.com/fharper/awesome-supernote) - Curated resource list.\n- [sn2md](https://github.com/dsummersl/sn2md) - Supernote to text/image converter.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallenporter%2Fsupernote-lite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallenporter%2Fsupernote-lite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallenporter%2Fsupernote-lite/lists"}