comic-ocr-reader 0.0.4__tar.gz → 1.0.3__tar.gz

comic_ocr_reader-1.0.3/.github/workflows/python-publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

{comic_ocr_reader-0.0.4 → comic_ocr_reader-1.0.3}/.gitignore

@@ -1,95 +1,95 @@
-# Covers JetBrains IDEs: IntelliJ, GoLand, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
-# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-
-# User-specific stuff
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/**/usage.statistics.xml
-.idea/**/dictionaries
-.idea/**/shelf
-
-# AWS User-specific
-.idea/**/aws.xml
-
-# Generated files
-.idea/**/contentModel.xml
-
-# Sensitive or high-churn files
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-.idea/**/dbnavigator.xml
-
-# Gradle
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# Gradle and Maven with auto-import
-# When using Gradle or Maven with auto-import, you should exclude module files,
-# since they will be recreated, and may cause churn.  Uncomment if using
-# auto-import.
-# .idea/artifacts
-# .idea/compiler.xml
-# .idea/jarRepositories.xml
-# .idea/modules.xml
-# .idea/*.iml
-# .idea/modules
-# *.iml
-# *.ipr
-
-# CMake
-cmake-build-*/
-
-# Mongo Explorer plugin
-.idea/**/mongoSettings.xml
-
-# File-based project format
-*.iws
-
-# IntelliJ
-out/
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Cursive Clojure plugin
-.idea/replstate.xml
-
-# SonarLint plugin
-.idea/sonarlint/
-# see https://community.sonarsource.com/t/is-the-file-idea-idea-idea-sonarlint-xml-intended-to-be-under-source-control/121119
-.idea/sonarlint.xml
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-
-# Editor-based HTTP Client
-.idea/httpRequests
-http-client.private.env.json
-
-# Android studio 3.1+ serialized cache file
-.idea/caches/build_file_checksums.ser
-
-# Apifox Helper cache
-.idea/.cache/.Apifox_Helper
-.idea/ApifoxUploaderProjectSetting.xml
-
-# Github Copilot persisted session migrations, see: https://github.com/microsoft/copilot-intellij-feedback/issues/712#issuecomment-3322062215
-.idea/**/copilot.data.migration.*.xml
-
-# ------------------------------------------------------
-/src/test-pics
-/src/outputs
-/test-pics
-/outputs
-/temporary
+# Covers JetBrains IDEs: IntelliJ, GoLand, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+# see https://community.sonarsource.com/t/is-the-file-idea-idea-idea-sonarlint-xml-intended-to-be-under-source-control/121119
+.idea/sonarlint.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based HTTP Client
+.idea/httpRequests
+http-client.private.env.json
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+# Apifox Helper cache
+.idea/.cache/.Apifox_Helper
+.idea/ApifoxUploaderProjectSetting.xml
+
+# Github Copilot persisted session migrations, see: https://github.com/microsoft/copilot-intellij-feedback/issues/712#issuecomment-3322062215
+.idea/**/copilot.data.migration.*.xml
+
+# ------------------------------------------------------
+/src/test-pics
+/src/outputs
+/test-pics
+/outputs
+/temporary
 /dist

{comic_ocr_reader-0.0.4 → comic_ocr_reader-1.0.3}/.idea/comic-ocr.iml

@@ -1,7 +1,7 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module version="4">
-  <component name="PyDocumentationSettings">
-    <option name="format" value="GOOGLE" />
-    <option name="myDocStringFormat" value="Google" />
-  </component>
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="PyDocumentationSettings">
+    <option name="format" value="GOOGLE" />
+    <option name="myDocStringFormat" value="Google" />
+  </component>
 </module>

{comic_ocr_reader-0.0.4 → comic_ocr_reader-1.0.3}/.idea/misc.xml

@@ -1,7 +1,7 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="Black">
-    <option name="sdkName" value="Python 3.14 (comic-ocr) (2)" />
-  </component>
-  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.14 (comic-ocr)" project-jdk-type="Python SDK" />
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Black">
+    <option name="sdkName" value="Python 3.14 (comic-ocr) (2)" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.14 (comic-ocr)" project-jdk-type="Python SDK" />
 </project>

{comic_ocr_reader-0.0.4 → comic_ocr_reader-1.0.3}/.idea/vcs.xml

@@ -1,6 +1,6 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
 </project>

{comic_ocr_reader-0.0.4 → comic_ocr_reader-1.0.3}/LICENSE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Haganta R. Ginting
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2026 Haganta R. Ginting
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

{comic_ocr_reader-0.0.4 → comic_ocr_reader-1.0.3}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: comic_ocr_reader
-Version: 0.0.4
+Version: 1.0.3
 Summary: A Python package made for processing Japanese manga into a format usable with web-based on-screen dictionaries like Yomitan.
 Project-URL: Homepage, https://github.com/HagantaRG/comic-ocr
 Author-email: HRG <rhaganta@gmail.com>
 License-Expression: MIT
-License-File: LICENSE.MD
+License-File: LICENSE.md
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.9
@@ -20,16 +20,30 @@ Description-Content-Type: text/markdown
 # Jelly's Manga Reading Thingy.
 This is my own rendition of the excellent [Mokuro](https://github.com/kha-white/mokuro) project, made mostly just to do it.
 That being said, if you have any suggestions, please give me a heads-up and I will be happy to implement it. Probably.
-
+## Installation
+To install, you should only need to run:
+```
+pip install comic-ocr-reader
+```
+Once that it is installed (it may take some time, there are large dependencies in there) you should then run:
+```
+comic_ocr_reader
+```
+Or if that doesn't work:
+```
+python3 -m comic_ocr_reader
+```
 ## Usage
 1. Prepare a folder containing the images you would like to process. As of v.0.0.1 the images in this folder must be named the page number you would like that image to be.
    (e.g. the PNG image you would like to use as the second page should be titled "2.png")
    The name of the folder will be the name of the resultant HTML file. (e.g. if your folder is titled "Naruto" the output HTML file will be "Naruto.html" )
 2. Run comic-reader-ocr and enter the "folder" command.
 3. Enter the absolute path of the folder from step 1 and wait for comic-reader-ocr to process all the images.
-4. Once finished, the resulting HTML file will be placed in an outputs folder within the folder from step 1.
+4. Once finished, the resulting HTML file will be placed within the folder from step 1.
 5. Open the resulting HTML using your web browser of choice.
-
+### Notes
+- You *will* need to keep the HTML file within the same folder as all the rest of the pages. Otherwise, the images will not load.
+- Depending on your hardware, it may take quite some time to fully process all pages. On my laptop, it took roughly ~8s/page. I imagine on something with an actual GPU it would be faster though.
 ## FAQs (as decided by Myself)
 1. Is this a worse version of various other projects (e.g. [Mokuro](https://github.com/kha-white/mokuro))?
 

{comic_ocr_reader-0.0.4 → comic_ocr_reader-1.0.3}/README.md

@@ -1,37 +1,51 @@
-# Jelly's Manga Reading Thingy.
-This is my own rendition of the excellent [Mokuro](https://github.com/kha-white/mokuro) project, made mostly just to do it.
-That being said, if you have any suggestions, please give me a heads-up and I will be happy to implement it. Probably.
-
-## Usage
-1. Prepare a folder containing the images you would like to process. As of v.0.0.1 the images in this folder must be named the page number you would like that image to be.
-   (e.g. the PNG image you would like to use as the second page should be titled "2.png")
-   The name of the folder will be the name of the resultant HTML file. (e.g. if your folder is titled "Naruto" the output HTML file will be "Naruto.html" )
-2. Run comic-reader-ocr and enter the "folder" command.
-3. Enter the absolute path of the folder from step 1 and wait for comic-reader-ocr to process all the images.
-4. Once finished, the resulting HTML file will be placed in an outputs folder within the folder from step 1.
-5. Open the resulting HTML using your web browser of choice.
-
-## FAQs (as decided by Myself)
-1. Is this a worse version of various other projects (e.g. [Mokuro](https://github.com/kha-white/mokuro))?
-
-   - Yes.
-
-2. Do you know how to like. Write things. That work?
-
-   - No.
-
-3. Why did you do this?
-
-   - As a learning exercise, mostly. Plus, I like trying to reinvent wheels.
-
-4. Can I make suggestions?
-
-   - Yes. 
-
-5. Did you use AI for this?
-
-   - Yes. Most of the HTML and JS was AI generated, as unfortunately I really *really* don't like looking at either of those things.
-
-6. Are you going to try to make this a webapp because that probably makes a lot of sense or just. Like. Something that isn't Python so that it's easier to distribute or something?
-
-   - Yes. I'll probably try to rewrite this in Rust or do something like the [mokuro-reader](https://github.com/Gnathonic/mokuro-reader) project.
+# Jelly's Manga Reading Thingy.
+This is my own rendition of the excellent [Mokuro](https://github.com/kha-white/mokuro) project, made mostly just to do it.
+That being said, if you have any suggestions, please give me a heads-up and I will be happy to implement it. Probably.
+## Installation
+To install, you should only need to run:
+```
+pip install comic-ocr-reader
+```
+Once that it is installed (it may take some time, there are large dependencies in there) you should then run:
+```
+comic_ocr_reader
+```
+Or if that doesn't work:
+```
+python3 -m comic_ocr_reader
+```
+## Usage
+1. Prepare a folder containing the images you would like to process. As of v.0.0.1 the images in this folder must be named the page number you would like that image to be.
+   (e.g. the PNG image you would like to use as the second page should be titled "2.png")
+   The name of the folder will be the name of the resultant HTML file. (e.g. if your folder is titled "Naruto" the output HTML file will be "Naruto.html" )
+2. Run comic-reader-ocr and enter the "folder" command.
+3. Enter the absolute path of the folder from step 1 and wait for comic-reader-ocr to process all the images.
+4. Once finished, the resulting HTML file will be placed within the folder from step 1.
+5. Open the resulting HTML using your web browser of choice.
+### Notes
+- You *will* need to keep the HTML file within the same folder as all the rest of the pages. Otherwise, the images will not load.
+- Depending on your hardware, it may take quite some time to fully process all pages. On my laptop, it took roughly ~8s/page. I imagine on something with an actual GPU it would be faster though.
+## FAQs (as decided by Myself)
+1. Is this a worse version of various other projects (e.g. [Mokuro](https://github.com/kha-white/mokuro))?
+
+   - Yes.
+
+2. Do you know how to like. Write things. That work?
+
+   - No.
+
+3. Why did you do this?
+
+   - As a learning exercise, mostly. Plus, I like trying to reinvent wheels.
+
+4. Can I make suggestions?
+
+   - Yes. 
+
+5. Did you use AI for this?
+
+   - Yes. Most of the HTML and JS was AI generated, as unfortunately I really *really* don't like looking at either of those things.
+
+6. Are you going to try to make this a webapp because that probably makes a lot of sense or just. Like. Something that isn't Python so that it's easier to distribute or something?
+
+   - Yes. I'll probably try to rewrite this in Rust or do something like the [mokuro-reader](https://github.com/Gnathonic/mokuro-reader) project.

{comic_ocr_reader-0.0.4 → comic_ocr_reader-1.0.3}/pyproject.toml

@@ -1,30 +1,30 @@
-[build-system]
-requires = ["hatchling >= 1.26"]
-build-backend = "hatchling.build"
-
-[project]
-name = "comic_ocr_reader"
-version = "0.0.4"
-authors = [
-  { name="HRG", email="rhaganta@gmail.com" },
-]
-description = "A Python package made for processing Japanese manga into a format usable with web-based on-screen dictionaries like Yomitan."
-readme = "README.md"
-requires-python = ">=3.9"
-dependencies = [
-  "easyocr~=1.7.2",
-  "pillow~=12.3.0",
-  "numpy~=2.5.1",
-  "manga-ocr",
-  "tqdm",
-  "loguru",
-]
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "Operating System :: OS Independent",
-]
-license = "MIT"
-license-files = ["LICENSE.MD"]
-
-[project.urls]
-Homepage = "https://github.com/HagantaRG/comic-ocr"
+[build-system]
+requires = ["hatchling >= 1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "comic_ocr_reader"
+version = "1.0.3"
+authors = [
+  { name="HRG", email="rhaganta@gmail.com" },
+]
+description = "A Python package made for processing Japanese manga into a format usable with web-based on-screen dictionaries like Yomitan."
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+  "easyocr~=1.7.2",
+  "pillow~=12.3.0",
+  "numpy~=2.5.1",
+  "manga-ocr",
+  "tqdm",
+  "loguru",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICENSE.md"]
+
+[project.urls]
+Homepage = "https://github.com/HagantaRG/comic-ocr"

{comic_ocr_reader-0.0.4 → comic_ocr_reader-1.0.3}/requirements.txt

@@ -1,4 +1,4 @@
-easyocr~=1.7.2
-pillow~=12.3.0
-numpy~=2.5.1
+easyocr~=1.7.2
+pillow~=12.3.0
+numpy~=2.5.1
 manga-ocr