{"id":29161806,"url":"https://github.com/jaredrummler/jsp","last_synced_at":"2025-07-01T04:09:14.217Z","repository":{"id":301783516,"uuid":"1010300554","full_name":"jaredrummler/jsp","owner":"jaredrummler","description":"A command-line tool for Mormon enthusiasts and scholars to enhance their experience using the Joseph Smith Papers project.","archived":false,"fork":false,"pushed_at":"2025-06-28T20:22:51.000Z","size":10,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"develop","last_synced_at":"2025-06-28T20:31:22.512Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/jaredrummler.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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-06-28T19:22:26.000Z","updated_at":"2025-06-28T20:22:54.000Z","dependencies_parsed_at":"2025-06-28T20:31:38.443Z","dependency_job_id":"d63a0cd5-4cb6-415f-86ef-abdb4a4d94c1","html_url":"https://github.com/jaredrummler/jsp","commit_stats":null,"previous_names":["jaredrummler/jsp"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jaredrummler/jsp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredrummler%2Fjsp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredrummler%2Fjsp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredrummler%2Fjsp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredrummler%2Fjsp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaredrummler","download_url":"https://codeload.github.com/jaredrummler/jsp/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredrummler%2Fjsp/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262893663,"owners_count":23380712,"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-01T04:09:12.478Z","updated_at":"2025-07-01T04:09:14.206Z","avatar_url":"https://github.com/jaredrummler.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JSP: Joseph Smith Papers CLI Tool\n\nA command-line tool for Mormon enthusiasts and scholars to enhance their experience using the [Joseph Smith Papers](https://www.josephsmithpapers.org/) project.\n\n---\n\n## ✨ Features\n\n* **High-quality Image Retrieval**: Easily download and stitch high-resolution images from Joseph Smith Papers' OpenSeadragon viewer at maximum quality (JPEG quality 100 by default).\n* **Advanced Content Extraction**: Extract structured webpage content into Markdown format, including:\n  - Document transcriptions with optional editing marks removal\n  - Source notes and historical introductions\n  - Document information and metadata\n  - Footnotes with proper formatting\n  - Tables with markdown conversion\n  - Editorial marks and annotations\n  - Citation information (Chicago, MLA, APA formats)\n  - Repository and archive information\n* **Configuration Support**: Use JSON configuration files for consistent settings across multiple runs.\n* **Browser Automation**: Optional browser-based extraction for accurate transcription rendering.\n\n## 📌 Use Cases\n\n* **Historians**: Access high-fidelity images of original documents for scholarly publications.\n* **LDS Members**: View high-resolution images of historical items such as the Book of Abraham facsimiles.\n* **Researchers**: Download structured textual data from Joseph Smith Papers for detailed textual analysis, research, or AI-assisted analysis.\n\n---\n\n## 🚀 Installation\n\n### Using pip (Recommended)\n\n```bash\npip install jsp-papers\n```\n\n### Manual Installation\n\nClone the repository:\n\n```bash\ngit clone https://github.com/yourusername/jsp.git\ncd jsp\n```\n\nRun the install script (macOS/Linux):\n\n```bash\n./install.sh\n```\n\nFor Windows users, manual installation instructions will be provided soon.\n\n---\n\n## ⚙️ Usage\n\n### Default command (runs all available tasks)\n\n```bash\njsp process \u003cURL\u003e\n```\n\n### Individual commands\n\n#### Download and stitch high-quality image:\n\n```bash\njsp download-image \u003cURL\u003e\n```\n\n#### Scrape webpage content to Markdown:\n\n```bash\njsp scrape-content \u003cURL\u003e\n```\n\n### Command Options\n\n```bash\n# Specify output directory\njsp process \u003cURL\u003e -o /path/to/output\n\n# Set JPEG quality (1-100, default: 100)\njsp download-image \u003cURL\u003e --quality 95\n\n# Disable browser automation for faster scraping\njsp scrape-content \u003cURL\u003e --no-browser\n\n# Enable verbose output\njsp process \u003cURL\u003e -v\n\n# Preview actions without executing\njsp process \u003cURL\u003e --dry-run\n\n# Use configuration file\njsp process \u003cURL\u003e --config config.json\n\n# Set custom timeout (in seconds)\njsp process \u003cURL\u003e --timeout 60\n```\n\n### Configuration File\n\nCreate a `config.json` file to set default options:\n\n```json\n{\n  \"output_dir\": \"output\",\n  \"image_quality\": 100,\n  \"timeout\": 30,\n  \"use_browser\": true,\n  \"verbose\": false,\n  \"debug\": false\n}\n```\n\n### Output\n\nBy default, outputs will be placed in the following directory:\n\n```\noutput/{url-path}/\n├── image.jpg        # High-resolution stitched image\n├── content.md       # Extracted content in Markdown format\n└── content.json     # Structured data in JSON format\n```\n\nThe Markdown file includes all extracted sections:\n- Document breadcrumbs and navigation\n- Main content\n- Source notes with footnotes\n- Historical introductions\n- Document information\n- Full transcription (with optional editing marks)\n- Footnotes section\n- Tables (if present)\n- Metadata (citations and repository info)\n\nUse the `-o` or `--output` option to specify a custom output directory.\n\n---\n\n## 🛠 Requirements\n\n* **Python**: Version 3.9 or later recommended\n* **Operating Systems**: macOS prioritized; Windows compatibility intended but not yet fully tested.\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome! Please read our [contributing guide](CONTRIBUTING.md) and submit pull requests to our repository.\n\n---\n\n## 🤖 Agent Guidelines\n\nFor guidance on using AI-driven coding assistants, see:\n\n- [AGENTS.md](AGENTS.md) for OpenAI-powered agents (Codex CLI / ChatGPT).\n- [CLAUDE.md](CLAUDE.md) for Anthropic’s Claude agent.\n\n---\n\n## 📜 License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n---\n\n## 🐞 Issues \u0026 Feedback\n\nPlease submit any issues, bugs, or feature requests through [GitHub Issues](https://github.com/yourusername/jsp/issues).\n\n---\n\n*This project is actively under development.*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaredrummler%2Fjsp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaredrummler%2Fjsp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaredrummler%2Fjsp/lists"}