{"id":29475297,"url":"https://github.com/kdroidfilter/seforimlibrary","last_synced_at":"2025-07-14T16:07:16.236Z","repository":{"id":303447099,"uuid":"1012299640","full_name":"kdroidFilter/SeforimLibrary","owner":"kdroidFilter","description":"A Kotlin Multiplatform library for converting and accessing the Otzaria database in SQLite format with FTS5 full-text search capabilities.","archived":false,"fork":false,"pushed_at":"2025-07-07T16:52:15.000Z","size":324,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-07-07T17:58:35.251Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kdroidFilter.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}},"created_at":"2025-07-02T06:03:27.000Z","updated_at":"2025-07-07T16:39:36.000Z","dependencies_parsed_at":"2025-07-07T17:58:52.087Z","dependency_job_id":"7bbf9c36-c098-43b2-b65b-82aceac6a88d","html_url":"https://github.com/kdroidFilter/SeforimLibrary","commit_stats":null,"previous_names":["kdroidfilter/seforimlibrary"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/kdroidFilter/SeforimLibrary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdroidFilter%2FSeforimLibrary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdroidFilter%2FSeforimLibrary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdroidFilter%2FSeforimLibrary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdroidFilter%2FSeforimLibrary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kdroidFilter","download_url":"https://codeload.github.com/kdroidFilter/SeforimLibrary/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdroidFilter%2FSeforimLibrary/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265314629,"owners_count":23745315,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2025-07-14T16:07:15.637Z","updated_at":"2025-07-14T16:07:16.228Z","avatar_url":"https://github.com/kdroidFilter.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SeforimLibrary\n\nA Kotlin Multiplatform library for converting and accessing the Otzaria database in SQLite format with FTS5 full-text search capabilities.\n\n## Overview\n\nSeforimLibrary is a comprehensive solution for working with Jewish religious texts from the Otzaria database. The project converts the original Otzaria database into a modern SQLite database with full-text search capabilities using FTS5, making it efficient to search through large volumes of text.\n\nThe library is structured as a set of modules that can be imported via Maven:\n\n- **core**: Contains data models representing entities like books, authors, categories, and lines of text\n- **dao**: Provides database access objects and repositories for interacting with the SQLite database\n- **generator**: Handles the conversion of the original Otzaria database to SQLite format\n\n## Features\n\n- Convert Otzaria database to SQLite format\n- Efficient full-text search using SQLite's FTS5\n- Hierarchical category and book organization\n- Table of contents navigation for books\n- Support for links between related texts\n- Comprehensive data model for Jewish religious texts\n\n## Run Sample App\n\n- Desktop JVM: `./gradlew :sample:composeApp:run`\n- Android: `open project in Android Studio and run the sample app`\n\n\n## Requirements\n\n- JDK 11 or higher\n- Kotlin 1.9.0 or higher\n- SQLite 3.35.0 or higher (for FTS5 support)\n\n## Usage\n\n### Initializing the Database\n\n```kotlin\n// Initialize the database\nval dbPath = \"path/to/your/database.db\"\nval driver = JdbcSqliteDriver(url = \"jdbc:sqlite:$dbPath\")\nval repository = SeforimRepository(dbPath, driver)\n```\n\n### Searching for Text\n\n```kotlin\n// Search in all books\nval searchResults = repository.search(\"your search query\", limit = 20, offset = 0)\n\n// Search in a specific book\nval bookSearchResults = repository.searchInBook(bookId, \"your search query\")\n\n// Search by author\nval authorSearchResults = repository.searchByAuthor(\"author name\", \"your search query\")\n```\n\n### Browsing Categories and Books\n\n```kotlin\n// Get root categories\nval rootCategories = repository.getRootCategories()\n\n// Get subcategories\nval subcategories = repository.getCategoryChildren(parentId)\n\n// Get books in a category\nval books = repository.getBooksByCategory(categoryId)\n```\n\n### Reading Book Content\n\n```kotlin\n// Get book details\nval book = repository.getBook(bookId)\n\n// Get lines of text\nval lines = repository.getLines(bookId, startIndex, endIndex)\n\n// Get table of contents\nval toc = repository.getBookToc(bookId)\n```\n\n## Database Generation\n\nTo convert the original Otzaria database to SQLite format:\n\n```kotlin\n// Initialize repository\nval repository = SeforimRepository(dbPath, driver)\n\n// Create generator with source directory\nval sourcePath = Path(\"/path/to/otzaria_source\")\nval generator = DatabaseGenerator(sourcePath, repository)\n\n// Generate the database\ngenerator.generate()\n```\n\n## Project Structure\n\n- **core**: Contains data models and extensions\n  - `models`: Data classes representing entities in the database\n  - `extensions`: Utility extensions for working with the models\n\n- **dao**: Database access layer\n  - `repository`: Repository classes for accessing the database\n  - `extensions`: Extensions for converting between database and model objects\n  - `sqldelight`: SQL queries and database schema\n\n- **generator**: Database generation tools\n  - `DatabaseGenerator`: Main class for converting Otzaria data to SQLite\n  - `Main`: Entry point for running the generator as a standalone application\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkdroidfilter%2Fseforimlibrary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkdroidfilter%2Fseforimlibrary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkdroidfilter%2Fseforimlibrary/lists"}