├── .github └── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── .gitignore ├── LICENSE ├── README.md ├── images ├── demo.jpeg ├── flowchart.svg └── yomichan-import.png ├── requirements.txt ├── tab2opf.py └── yomi2tab.py /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | 5 | --- 6 | 7 | **Describe the bug** 8 | A clear and concise description of what the bug is. 9 | 10 | **To Reproduce** 11 | Steps to reproduce the behavior: 12 | 1. Run '...' on '...' 13 | 2. Use the '...' option 14 | 3. See error 15 | 16 | **Expected behavior** 17 | A clear and concise description of what you expected to happen. 18 | 19 | **Screenshots** 20 | If applicable, add screenshots to help explain your problem. 21 | 22 | **Desktop (please complete the following information):** 23 | - OS: [e.g. Windows] 24 | - Python version [e.g. 3.7] 25 | 26 | **Additional context** 27 | Add any other context about the problem here. 28 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | 5 | --- 6 | 7 | **Is your feature request related to a problem? Please describe.** 8 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 9 | 10 | **Describe the solution you'd like** 11 | A clear and concise description of what you want to happen. 12 | 13 | **Describe alternatives you've considered** 14 | A clear and concise description of any alternative solutions or features you've considered. 15 | 16 | **Additional context** 17 | Add any other context or screenshots about the feature request here. 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | data/* 2 | opf/* 3 | daijirin/* 4 | yomi_output/* 5 | gh-md-toc 6 | *.csv 7 | *.tab 8 | 9 | 10 | # Created by https://www.gitignore.io/api/macos,python 11 | 12 | ### macOS ### 13 | *.DS_Store 14 | .AppleDouble 15 | .LSOverride 16 | 17 | # Icon must end with two \r 18 | Icon 19 | 20 | # Thumbnails 21 | ._* 22 | 23 | # Files that might appear in the root of a volume 24 | .DocumentRevisions-V100 25 | .fseventsd 26 | .Spotlight-V100 27 | .TemporaryItems 28 | .Trashes 29 | .VolumeIcon.icns 30 | .com.apple.timemachine.donotpresent 31 | 32 | # Directories potentially created on remote AFP share 33 | .AppleDB 34 | .AppleDesktop 35 | Network Trash Folder 36 | Temporary Items 37 | .apdisk 38 | 39 | ### Python ### 40 | # Byte-compiled / optimized / DLL files 41 | __pycache__/ 42 | *.py[cod] 43 | *$py.class 44 | 45 | # C extensions 46 | *.so 47 | 48 | # Distribution / packaging 49 | .Python 50 | build/ 51 | develop-eggs/ 52 | dist/ 53 | downloads/ 54 | eggs/ 55 | .eggs/ 56 | lib/ 57 | lib64/ 58 | parts/ 59 | sdist/ 60 | var/ 61 | wheels/ 62 | *.egg-info/ 63 | .installed.cfg 64 | *.egg 65 | 66 | # PyInstaller 67 | # Usually these files are written by a python script from a template 68 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 69 | *.manifest 70 | *.spec 71 | 72 | # Installer logs 73 | pip-log.txt 74 | pip-delete-this-directory.txt 75 | 76 | # Unit test / coverage reports 77 | htmlcov/ 78 | .tox/ 79 | .coverage 80 | .coverage.* 81 | .cache 82 | .pytest_cache/ 83 | nosetests.xml 84 | coverage.xml 85 | *.cover 86 | .hypothesis/ 87 | 88 | # Translations 89 | *.mo 90 | *.pot 91 | 92 | # Flask stuff: 93 | instance/ 94 | .webassets-cache 95 | 96 | # Scrapy stuff: 97 | .scrapy 98 | 99 | # Sphinx documentation 100 | docs/_build/ 101 | 102 | # PyBuilder 103 | target/ 104 | 105 | # Jupyter Notebook 106 | .ipynb_checkpoints 107 | 108 | # pyenv 109 | .python-version 110 | 111 | # celery beat schedule file 112 | celerybeat-schedule.* 113 | 114 | # SageMath parsed files 115 | *.sage.py 116 | 117 | # Environments 118 | .env 119 | .venv 120 | env/ 121 | venv/ 122 | ENV/ 123 | env.bak/ 124 | venv.bak/ 125 | 126 | # Spyder project settings 127 | .spyderproject 128 | .spyproject 129 | 130 | # Rope project settings 131 | .ropeproject 132 | 133 | # mkdocs documentation 134 | /site 135 | 136 | # mypy 137 | .mypy_cache/ 138 | 139 | 140 | # End of https://www.gitignore.io/api/macos,python 141 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Epwing2Kindle: A guide on how to convert Japanese EPWING dictionaries to a kindle-readable format 2 | 3 |

4 | Result demonstration
5 | Demonstration of the final result 6 |

7 | 8 | # Table of Contents 9 | 10 | - [Process description](#process-description) 11 | - [Usage guide](#usage-guide) 12 | - [1. Install the requirements](#1-install-the-requirements) 13 | - [2. EPWING to JSON (yomichan)](#2-epwing-to-json-yomichan) 14 | - [3. JSON to Tab (yomi2tab)](#3-json-to-tab-yomi2tab) 15 | - [4. Tab to OPF (tab2opf)](#4-tab-to-opf-tab2opf) 16 | - [5. OPF to mobi (kindlegen)](#5-opf-to-mobi-kindlegen) 17 | - [Todo](#todo) 18 | - [Another way to convert epwing](#another-way-to-convert-epwing) 19 | - [Miscellaneous](#miscellaneous) 20 | - [Something isn't working!](#something-isnt-working) 21 | - [Kindlegen is throwing weird warnings!](#kindlegen-is-throwing-weird-warnings) 22 | - [I'm on Windows and having trouble installing the python requirements](#im-on-windows-and-having-trouble-installing-the-python-requirements) 23 | - [Why would you ever do this? Kindle offers free builtin dictionaries!](#why-would-you-ever-do-this-kindle-offers-free-builtin-dictionaries) 24 | - [Shoutouts](#shoutouts) 25 | 26 | 27 | ## Process description 28 | 29 | ![Process flowchart](images/flowchart.svg) 30 | 31 | In order to convert an EPWING dictionary to kindle, you have to follow the process displayed above: first you convert the EPWING to a stardict format (TAB-separated), then using tab2opf you can convert it to opf (html) dictionary and then generate a mobi file using kindlegen. 32 | 33 | ## Usage guide 34 | 35 | ### 1. Install the requirements 36 | 37 | - [python 3.6 or higher](https://www.python.org/) 38 | - [yomichan-import](https://foosoft.net/projects/yomichan-import/) 39 | - [kindlegen](https://www.amazon.com/gp/feature.html?docId=1000765211) 40 | 41 | 42 | You can use either pip or [conda](https://www.anaconda.com/download/) to install the python requirements: 43 | 44 | ``` 45 | pip3 install -r requirements.txt 46 | conda install --file requirements.txt 47 | ``` 48 | 49 | ### 2. EPWING to JSON (yomichan) 50 | 51 | ``` 52 | ./yomichan-import 53 | ``` 54 | [Yomichan-import](https://github.com/FooSoft/yomichan-import/) is a great app that utilizes [zero-epwing](https://github.com/FooSoft/zero-epwing) to convert EPWING data into much more easily parseable JSON files. 55 | 56 | **Note for Windows users**: Because zero-epwing does not support non-ASCII characters (like the Japanese ones), yomichan-import won't work if you have any of them in your CATALOGS path. It should work just fine on unix systems. 57 | 58 |
59 |

60 | Result demonstration
61 | How to use yomichan-import 62 |

63 | 64 | 65 | ### 3. JSON to Tab (yomi2tab) 66 | ``` 67 | (Unix) python3 yomi2tab.py -o mydict.tab yomi_output/ 68 | (Windows) py -3 yomi2tab.py -o mydict.tab "C:\YOUR_PATH_HERE\yomi_output" 69 | ``` 70 | 71 | Yomichan-import generates an archive file that you have to unzip into a folder (called `yomi_output` in the above example) for `yomi2tab` to work. You can also use the `./yomi2tab.py -h` flag to see all possible usage options. 72 | 73 | ### 4. Tab to OPF (tab2opf) 74 | 75 | ``` 76 | (Unix) python3 tab2opf.py mydict.tab 77 | (Windows) py -3 tab2opf.py mydict.tab 78 | ``` 79 | 80 | Running this command will create a folder called `opf/` that will contain the opf/html dictionary you can use in the next step. 81 | 82 | This repository provides a japanese-specific tab2opf tool with some improvements (adding progress indicators, correct display of `<`/`>`, etc.). It is based on https://github.com/apeyser/tab2opf by Alexander Peyser from 2015 which itself is based on the generally available tab2opf.py by Klokan Petr Přidal (www.klokan.cz) from 2007. 83 | 84 | ### 5. OPF to mobi (kindlegen) 85 | 86 | ``` 87 | kindlegen opf/mydict.opf 88 | ``` 89 | 90 | In order to generate a .mobi dictionary from OPF, you can use a tool called [kindlegen](https://www.amazon.com/gp/feature.html?docId=1000765211) that's provided by amazon. It may take a while to convert everything but doesn't require any extra work. 91 | 92 | After you've generated a .mobi dictionary, you can import it into [calibre](https://calibre-ebook.com) to edit the metadata, add a cover picture and send it to kindle. 93 | 94 | ## Todo 95 | 96 | *PR's are welcome!* 97 | 98 | - [x] Convert EPWING dictionary to kindle 99 | - [x] Proper formatting, newlines are rendering as they should be 100 | - [x] \(mostly) Optional "Simple" mode without old ways to write a word that use outdated kana 101 | - [x] Support kanji when the entry is formatted as `[Kanji/Hiragana]Katakana[K/H]` 102 | - [x] Multiple entries for the same word (not merging all of the definitions into one; official kindle dictionaries function in this way) 103 | - [x] Tested with 大辞林 104 | - [ ] Add a zsh/python script for processing everything automatically 105 | - [ ] Better sorting for multiple entries 106 | - [ ] Test more dictionaries 107 | - [ ] Improve performance (low priority) 108 | - [ ] Make it possible to look up suffixes (stuff like -好き; low priority) 109 | - [ ] Make it possible to look up phrases with `=` in their key (It's probably another weird EPWING thing; low priority) 110 | 111 | *Note*: this process was tested using スーパー大辞林, and while using it with other dictionaries (full list [here](https://github.com/FooSoft/yomichan-import)) should still work some unexpected problems may arise. If you manage to successfully import another dictionary using this repo, please add a photo of your final result to the images folder via a pull request. 112 | 113 | 114 | ## Another way to convert epwing 115 | 116 | We can also use the noj format as an intermediary between the EPWING dictionary and the tab file. 117 | 118 | **Steps:** 119 | 120 | 1. https://github.com/mcho421/noj_dumpers 121 | * Don't bother with compiling it because won't work, just copy your files to the noj_dumper folder and then `python2 noj_dumper.py epwing_folder` 122 | 2. https://github.com/asika/noj2tab (you can try reading the Chinese blog post with google translate) 123 | 3. Tab2Opf (mine or https://github.com/apeyser/tab2opf) 124 | 4. kindlegen + calibre 125 | 126 | 127 | ## Miscellaneous 128 | 129 | ### Something isn't working! 130 | 131 | Open an [issue](https://github.com/olety/epwing2kindle/issues) on github, I'm checking this page quite regularly and will respond as soon as I can. 132 | 133 | Also, please check closed issues before opening a new one, maybe your problem was already solved there. 134 | 135 | ### Kindlegen is throwing weird warnings! 136 | 137 | If it actually produces a .mobi file at the end those warnings can be ignored; try putting the resulting dictionary on your kindle first and check if you can look up words. If not, open an [issue](https://github.com/olety/epwing2kindle/issues) :) 138 | 139 | ### I'm on Windows and having trouble installing the python requirements 140 | 141 | Check issue [#1](https://github.com/olety/epwing2kindle/issues/1) - you may have to install [Build Tools for Visual Studio](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2017) to get everything working. 142 | 143 | ### Why would you ever do this? Kindle offers free builtin dictionaries! 144 | 145 | デジタル大辞泉 provided with Kindle doesn't have pitch accent marks. 146 | 147 | ### Shoutouts 148 | 149 | - [Cophnia61](https://forum.koohii.com/user-4654.html) - https://forum.koohii.com/thread-14949.html (I'm not Xavier22 😁 ) 150 | - [gh-md-toc](https://github.com/ekalinin/github-markdown-toc) - *the* TOC generator for github 151 | - [Xavier22](https://github.com/erikolson97), for helping with the Windows-specific instructions 152 | 153 | And you, if you actually convert your epwing to mobi! 😊 154 | -------------------------------------------------------------------------------- /images/demo.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/olety/epwing2kindle/cde24fc8c731729855037fe17460bb92b352128a/images/demo.jpeg -------------------------------------------------------------------------------- /images/flowchart.svg: -------------------------------------------------------------------------------- 1 | 2 | 4 | 152 | -------------------------------------------------------------------------------- /images/yomichan-import.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/olety/epwing2kindle/cde24fc8c731729855037fe17460bb92b352128a/images/yomichan-import.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pandas==0.20.3 2 | tqdm==4.19.2 3 | -------------------------------------------------------------------------------- /tab2opf.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Script for conversion of Stardict tabfile (
\t 5 | # per line) into the OPF file for MobiPocket Dictionary 6 | # 7 | # For usage of dictionary convert it by: 8 | # (wine) mobigen.exe DICTIONARY.opf 9 | # or now... 10 | # kindlegen DICTIONARY.opf 11 | # 12 | # MobiPocket Reader at: www.mobipocket.com for platforms: 13 | # PalmOs, Windows Mobile, Symbian (Series 60, Series 80, 90, UIQ), Psion, Blackberry, Franklin, iLiad (by iRex), BenQ-Siemens, Pepper Pad.. 14 | # http://www.mobipocket.com/en/DownloadSoft/DownloadManualInstall.asp 15 | # mobigen.exe available at: 16 | # http://www.mobipocket.com/soft/prcgen/mobigen.zip 17 | # 18 | # Copyright (C) 2007 - Klokan Petr Přidal (www.klokan.cz) 19 | # Copyright (C) 2015 - Alexander Peyser (github.com/apeyser) 20 | # Copyright (C) 2018 - Oleksii Kyrylchuk (https://github.com/olety) 21 | # 22 | # Version history: 23 | # 0.1 (19.7.2007) Initial version 24 | # 0.2 (2/2015) Rework removing encoding, runs on python3 25 | # 0.2.1 (2/2018) Added progress bar, optimized for japanese. 26 | # 0.2.2 (3/2018) Added docstrings, proper multiple definitions, f-strings, "->' 27 | # 28 | # This library is free software; you can redistribute it and/or 29 | # modify it under the terms of the GNU Library General Public 30 | # License as published by the Free Software Foundation; either 31 | # version 2 of the License, or (at your option) any later version. 32 | # 33 | # This library is distributed in the hope that it will be useful, 34 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 35 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 36 | # Library General Public License for more details. 37 | # 38 | # You should have received a copy of the GNU Library General Public 39 | # License along with this library; if not, write to the 40 | # Free Software Foundation, Inc., 59 Temple Place - Suite 330, 41 | # Boston, MA 02111-1307, USA. 42 | 43 | # VERSION 44 | VERSION = "0.2.2" 45 | 46 | import sys 47 | import os 48 | import argparse 49 | from itertools import islice, count, groupby 50 | from contextlib import contextmanager 51 | from tqdm import tqdm 52 | import importlib 53 | 54 | 55 | def normalizeLetter(ch): 56 | # Stop with the encoding -- it's broken anyhow 57 | # in the kindles and undefined. 58 | try: 59 | ch = mapping[ch] 60 | except KeyError: 61 | pass 62 | return ch 63 | 64 | 65 | def normalizeUnicode(text): 66 | ''' 67 | Reduce some characters to something else 68 | ''' 69 | return ''.join(normalizeLetter(c) for c in text) 70 | 71 | 72 | def parseargs(): 73 | # Args: 74 | # --verbose 75 | # --module: module to load and attempt to extract getdef, getkey & mapping 76 | # --source: source language code (en by default) 77 | # --target: target language code (en by default) 78 | # file: the tab delimited file to read 79 | parser = argparse.ArgumentParser( 80 | 'tab2opf', formatter_class=argparse.ArgumentDefaultsHelpFormatter, 81 | description=f'Tab2Opf [v{VERSION}] Converts dictionaries from a ' 82 | 'tab-separated Stardict format into OPF/html format that can be ' 83 | 'further be converted to MOBI with kindlegen. Made by ' 84 | 'Klokan Petr Přidal, Alexander Peyser, Oleksii Kyrylchuk.') 85 | parser.add_argument('-v', '--verbose', help='make verbose', 86 | action='store_true') 87 | parser.add_argument('-m', '--module', 88 | help='Import module for mapping, getkey, getdef') 89 | parser.add_argument('-s', '--source', default='ja', help='Source language') 90 | parser.add_argument('-t', '--target', default='ja', help='Target language') 91 | parser.add_argument('-o', '--output', default='opf', help='Target folder') 92 | parser.add_argument('file', help='tab file to input') 93 | return parser.parse_args() 94 | 95 | 96 | def loadmember(mod, attr, dfault): 97 | if hasattr(mod, attr): 98 | print(f'Loading {attr} from {mod.__name__}') 99 | globals()[attr] = getattr(mod, attr) 100 | else: 101 | globals()[attr] = dfault 102 | 103 | 104 | def importmod(): 105 | global MODULE 106 | if MODULE is None: 107 | mod = None 108 | else: 109 | mod = importlib.import_module(MODULE) 110 | print(f'Loading methods from: {mod.__file__}') 111 | 112 | loadmember(mod, 'getkey', lambda key: key) 113 | loadmember(mod, 'getdef', lambda dfn: dfn) 114 | loadmember(mod, 'mapping', {}) 115 | 116 | 117 | args = parseargs() 118 | if not os.path.exists(args.output): 119 | os.makedirs(args.output) 120 | VERBOSE = args.verbose 121 | FILENAME = args.file 122 | MODULE = args.module 123 | INLANG = args.source 124 | OUTLANG = args.target 125 | importmod() 126 | 127 | 128 | def readkey(line, defs): 129 | ''' 130 | Add a single [term, definition] to the defs[key] dictionary. 131 | line is a tab split line to be parsed. 132 | ''' 133 | try: 134 | term, defn = line.split('\t', 1) 135 | except ValueError: 136 | print('Bad line: "{}"'.format(line)) 137 | raise 138 | 139 | term = term.strip() 140 | defn = getdef(defn) 141 | newl = '
\n' 142 | tab = ' ' 143 | defn = defn.replace('\\\\', '\\').\ 144 | replace('"', '\'').\ 145 | replace('>', '> ').\ 146 | replace('<', ' <').\ 147 | replace('（ア）', f'{newl}{tab}（ア）').\ 148 | replace('（イ）', f'{newl}{tab}（イ）').\ 149 | replace('（ウ）', f'{newl}{tab}（ウ）').\ 150 | replace('（エ）', f'{newl}{tab}（エ）').\ 151 | replace('（オ）', f'{newl}{tab}（オ）').\ 152 | replace('\\n', newl).\ 153 | strip() 154 | 155 | nkey = normalizeUnicode(term) 156 | key = getkey(nkey) 157 | key = key.\ 158 | replace('"', '\'').\ 159 | replace('<', '<').\ 160 | replace('>', '>').\ 161 | lower().strip() 162 | 163 | nkey = nkey.\ 164 | replace('"', '\'').\ 165 | replace('<', '<').\ 166 | replace('>', '>').\ 167 | lower().strip() 168 | 169 | if key == '': 170 | raise Exception(f'Missing key {term}') 171 | if defn == '': 172 | raise Exception(f'Missing definition {term}') 173 | 174 | if VERBOSE: 175 | print(key, ':', term) 176 | 177 | ndef = [term, defn, key == nkey] 178 | if key in defs: 179 | defs[key].append(ndef) 180 | else: 181 | defs[key] = [ndef] 182 | 183 | 184 | def inclline(s): 185 | ''' Filter that skips empty lines and lines that only have a comment ''' 186 | s = s.lstrip() 187 | return len(s) != 0 and s[0] != '#' 188 | 189 | 190 | def readkeys(): 191 | ''' 192 | Iterate over FILENAME, reading lines formatted like "term {tab} definition". 193 | Skips empty lines and commented out lines. 194 | ''' 195 | if VERBOSE: 196 | print('Reading {}'.format(FILENAME)) 197 | with open(FILENAME, 'r', encoding='utf-8') as fr: 198 | defs = {} 199 | 200 | for line in tqdm(filter(inclline, fr), unit='keys', desc='Reading keys'): 201 | readkey(line, defs) 202 | return defs 203 | 204 | 205 | @contextmanager 206 | def writekeyfile(name, i): 207 | ''' 208 | Write to key file '{name}{n}.html', put the body inside the context manager. 209 | The onclick here gives a kindlegen warning but appears to be necessary to 210 | actually have a lookup dictionary 211 | ''' 212 | fname = os.path.join(args.output, f'{name}{i}.html') 213 | if VERBOSE: 214 | print('Key file: {}'.format(fname)) 215 | with open(fname, 'w', encoding='utf-8') as to: 216 | to.write(''' 217 | 218 | 219 | 220 | 221 | 222 |
223 | Dictionary Search 224 |
225 | 226 | 227 | ''') 228 | try: 229 | yield to 230 | finally: 231 | to.write(''' 232 | 233 | 234 | 235 | ''') 236 | 237 | 238 | def keyf(defn): 239 | ''' 240 | Order definitions by keys, then by whether the key matches the original 241 | term, then by length of term then alphabetically. 242 | ''' 243 | term = defn[0] 244 | if defn[2]: 245 | l = 0 246 | else: 247 | l = len(term) 248 | return l, term 249 | 250 | 251 | def writekey(to, key, defn): 252 | ''' 253 | Write into to the key, definition pairs 254 | key -> [[term, defn, key==term]] 255 | ''' 256 | terms = iter(sorted(defn, key=keyf)) 257 | for term, g in groupby(terms, key=lambda d: d[0]): 258 | for thing in g: 259 | to.write( 260 | ''' 261 | 262 |

263 | {term} 264 |

265 | '''.format(term=term, key=key)) 266 | # Merge definitions; Added sorting to display japanese results first 267 | # defn = '
'.join(sorted(ndefn for _, ndefn, _ in g)) 268 | # Fixing the reading error where english definitions 269 | # generate extra spacing 270 | # defn.replace('
\n
', '
') 271 | to.write(thing[1]) 272 | to.write(''' 273 | 274 | ''') 275 | 276 | if VERBOSE: 277 | print(key) 278 | 279 | 280 | def writekeys(defns, name): 281 | ''' 282 | Write all the keys, where defns is a map of 283 | key --> [[term, defn, key==term]...] 284 | and name is the basename. 285 | 286 | The files are split so that there are no more than 10,000 keys written 287 | to each file. (why?? I dunno. Probably to reduce lag when opening them.) 288 | 289 | Returns the number of files. 290 | ''' 291 | keyit = iter(sorted(defns)) 292 | for j in tqdm(count(), unit='files', desc='Writing html'): 293 | with writekeyfile(name, j) as to: 294 | keys = list(islice(keyit, 10000)) 295 | if len(keys) == 0: 296 | break 297 | for key in keys: 298 | writekey(to, key, defns[key]) 299 | return j + 1 300 | 301 | 302 | @contextmanager 303 | def openopf(ndicts, name): 304 | ''' 305 | After writing keys, the opf that references all the key files is constructed. 306 | openopf wraps the contents of writeopf 307 | ''' 308 | fname = os.path.join(args.output, f'{name}.opf') 309 | if VERBOSE: 310 | print(f'Opf: {fname}') 311 | with open(fname, 'w', encoding='utf-8') as to: 312 | to.write(''' 313 | 314 | 315 | 316 | 317 | 318 | 319 | 320 | 321 | {name} 322 | 323 |

{name}

 324 | ja 325 | 326 | 327 | 328 | {source} 329 | {target} 330 | 331 | 332 | 333 | 334 | 335 | '''.format(name=name, source=INLANG, target=OUTLANG)) 336 | 337 | yield to 338 | 339 | to.write(''' 340 | 341 | 342 | 343 | ''' 344 | ) 345 | 346 | # Write the opf that describes all the key files 347 | 348 | 349 | def writeopf(ndicts, name): 350 | with openopf(ndicts, name) as to: 351 | for i in range(ndicts): 352 | to.write( 353 | ''' 354 | '''.format(ndict=i, name=name)) 355 | 356 | to.write(''' 357 | 358 | 359 | 360 | ''' 361 | ) 362 | for i in range(ndicts): 363 | to.write(''' 364 | 365 | '''.format(ndict=i)) 366 | 367 | to.write(''' 368 | 369 | ''') 370 | 371 | ###################################################### 372 | # main 373 | ###################################################### 374 | 375 | 376 | defns = readkeys() 377 | name = os.path.splitext(os.path.basename(FILENAME))[0] 378 | ndicts = writekeys(defns, name) 379 | print('Writing opf:') 380 | writeopf(ndicts, name) 381 | -------------------------------------------------------------------------------- /yomi2tab.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Script for converting an unzipped folder of yomichan json files into a 5 | # Stardict tabfile. \t 6 | # 7 | # (C) Oleksii Kyrylchuk 2018 (https://github.com/olety) 8 | # 9 | # Version history 10 | # v0.1 (04.02.2018) Basic functionalities 11 | # v0.2 (07.03.2018) Added proper katakana/kanji words processing, simplify mode 12 | # v0.2a (06.07.2018) Fixed a windows-related encoding issue (#1 on github) 13 | # v0.2b (10.03.2018) Fixed an issue with 明鏡 where some words were missing their headword 14 | # 15 | # This library is free software; you can redistribute it and/or 16 | # modify it under the terms of the GNU Library General Public 17 | # License as published by the Free Software Foundation; either 18 | # version 3 of the License, or (at your option) any later version. 19 | # 20 | # This library is distributed in the hope that it will be useful, 21 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 23 | # Library General Public License for more details. 24 | # 25 | # You should have received a copy of the GNU Library General Public 26 | # License along with this library; if not, write to the 27 | # Free Software Foundation, Inc., 59 Temple Place - Suite 330, 28 | # Boston, MA 02111-1307, USA. 29 | 30 | VERSION = '0.2b' 31 | 32 | import pprint 33 | import pandas as pd 34 | import argparse 35 | import logging 36 | import json 37 | import os 38 | from tqdm import tqdm 39 | from functools import partial 40 | from itertools import compress 41 | import sys 42 | 43 | 44 | def clean_brackets(definition_list): 45 | # Add extra spacing for 【 braces that don't have it 46 | return [defn.replace('【', ' 【') 47 | if len(defn.split(' 【')) == 1 48 | else defn 49 | for defn in definition_list] 50 | 51 | 52 | def transform_simplify(definition_list): 53 | # Remove '-random_katakana' from definitions 54 | new_def = '' 55 | for definition in definition_list: 56 | defn = definition.split('\n') 57 | # Processing the header 58 | header = defn[0].split(' ') 59 | try: 60 | if header[1][0] == '―': 61 | header = [header[0]] + header[2:] 62 | except: 63 | pass 64 | defn[0] = ' '.join(header).replace('-', '') 65 | 66 | # Appending the definition 67 | new_def += '\n'.join(defn) + '\n' 68 | return new_def 69 | 70 | 71 | def clean_word_starts(word): 72 | # Ending words like -好き have a dash in the beginning 73 | # making them unsearcheable 74 | word = word.replace('…', '') 75 | if word.startswith('−'): 76 | word = word[1:] 77 | return word 78 | 79 | 80 | def is_katakana(char): 81 | # https://en.wikipedia.org/wiki/Katakana_(Unicode_block) 82 | return ord('\u30ff') >= ord(char) >= ord('\u30a0') 83 | 84 | 85 | def process_katakana_kanji(row): 86 | # Word structure: [Kanji/Hiragana]―[Kanji/Hiragana] 87 | # Reading structure: [Kanji/Hiragana]Katakana[Kanji/Hiragana] 88 | # ― is a special symbol (not dash -) 89 | # row[0] = word; row[1] = reading; row[2] = defn 90 | if '―' in row[0]: 91 | try: 92 | is_ktk = [is_katakana(character) for character in row[1]] 93 | # Finding the start/end of the katakana chunk 94 | # There should be a more efficient way to do this 95 | ktk_start = is_ktk.index(True) 96 | ktk_end = len(row[1]) - is_ktk[::-1].index(True) 97 | # Getting the leading/trailing kanji 98 | kanji = row[0].split('―') 99 | # Modifying the word itself by replacing hiragana with kanji 100 | row[0] = kanji[0] + row[1][ktk_start:ktk_end] + kanji[1] 101 | except: 102 | pass 103 | 104 | return row 105 | 106 | 107 | def process_folder(foldername, simplify): 108 | logging.debug(f'Starting processing the folder {foldername}...') 109 | logging.debug('Initializing variables...') 110 | result = [] 111 | to_process = [os.path.join(foldername, f) 112 | for f in os.listdir(foldername) 113 | if f.endswith('.json') and not f.startswith('index')] 114 | logging.debug('Files to process:') 115 | logging.debug(pprint.pformat(to_process)) 116 | logging.debug('Starting the loop...') 117 | for file_path in tqdm(to_process, unit='file', desc='Processing files'): 118 | # Start and initializing 119 | logging.debug(f'Processing file {file_path}') 120 | 121 | logging.debug('Reading the json...') 122 | df = pd.read_json(file_path, encoding='utf-8') 123 | logging.debug(f'Successfully read the file {file_path}...') 124 | 125 | logging.debug('Selecting the correct columns...') 126 | df.columns = ['word', 'reading', 'unknown1', 'unknown2', 127 | 'unknown3', 'def', 'id', 'unknown4'] 128 | df = df[['word', 'reading', 'def']] 129 | logging.debug(f'Selected the columns {df.columns.values}...') 130 | 131 | # Hiragana-only words 132 | logging.debug('Starting processing the duplicate dataframe') 133 | logging.debug('This will allow us to look up words that are ' 134 | 'spelled with hiragana and not kanji.') 135 | df_kanji = df[df['reading'].str.len() != 0] 136 | logging.debug('Copying the reading column to the key column') 137 | df_kanji.loc[:, 'word'] = df_kanji['reading'] 138 | logging.debug('Concatenating the two dataframes, one for kanji words,' 139 | 'and the second one for hiragana words.') 140 | df = pd.concat([df, df_kanji]).sort_values( 141 | by='reading', ascending=False).reset_index(drop=True) 142 | 143 | # Transforming the def field + deleting dupes 144 | # Merging the definitions 145 | if simplify: 146 | logging.debug('Simplifying the definitions.') 147 | df['def'] = df['def'].apply(transform_simplify) 148 | else: 149 | logging.debug('Transforming the definition into one string.') 150 | df['def'] = df['def'].apply(lambda x: '\n'.join(x)) 151 | # Making mixed kanji/kanakana words display properly 152 | df = df.apply(process_katakana_kanji, axis=1) 153 | df['word'] = df['word'].apply(clean_word_starts) 154 | 155 | logging.debug('Appending the dataframe to the result array.') 156 | result.append(df) 157 | 158 | # Concatenating the result and returning it 159 | logging.debug('Concatenating the result array.') 160 | result = pd.concat(result) 161 | 162 | # Some extra changes due to how tab2opf treats newlines 163 | logging.debug('Changing the newlines from \\n -> \\\\n ' 164 | 'so tab2opf can read them.') 165 | result['def'] = result['def'].str.replace('\n', '\\n') 166 | 167 | # Dropping empty strings 168 | logging.debug('Deleting entries with empty headwords.') 169 | result.replace('', pd.np.nan, inplace=True) 170 | result.dropna(subset=['word', 'def'], inplace=True) 171 | 172 | # Deleting dupes 173 | logging.debug('Deleting duplicates.') 174 | result.drop_duplicates(inplace=True) 175 | 176 | # Maybe use a special sort for japanese characters? 177 | result = result.sort_values(by='word').reset_index() 178 | logging.debug('Returning the result dataframe.') 179 | return result 180 | 181 | 182 | if __name__ == '__main__': 183 | # Parsing the args 184 | parser = argparse.ArgumentParser( 185 | description=f'Yomi2Tab [v{VERSION}] Converts EPWINGS dictionaries from ' 186 | 'yomichan zipped json into a tab-separated format that can be ' 187 | 'used with tab2opf (Stardict). Made by Oleksii Kyrylchuk', 188 | formatter_class=argparse.ArgumentDefaultsHelpFormatter) 189 | 190 | # Source files 191 | parser.add_argument(type=str, metavar='path', dest='folder', 192 | help='Path to the unzipped yomichan-import ' 193 | 'archive folder with json files.') 194 | # Simplify defs 195 | parser.add_argument('-s', '--simplify', action='store_true', 196 | help='Simplify definitions. This gets rid of the extra ' 197 | 'archaic readings, which makes the resulting definition' 198 | ' easier to read.') 199 | # Destination 200 | parser.add_argument('-o', '--output', type=argparse.FileType('w', encoding='utf-8'), 201 | nargs='?', help='Output file path. Default behaviour: ' 202 | 'infers the name.', metavar='output_file', default=None) 203 | 204 | parser.add_argument('-v', '--verbose', action='store_true', 205 | help='Show verbose output.') 206 | # Parse the args 207 | args = parser.parse_args() 208 | 209 | # Setting up logging 210 | LOGGING_FMT = '%(levelname)s | %(asctime)s | line %(lineno)s | %(funcName)s | %(message)s' 211 | LOGGING_DATEFMT = '%H:%M:%S' 212 | 213 | logging_conf = partial(logging.basicConfig, format=LOGGING_FMT, 214 | datefmt=LOGGING_DATEFMT, stream=sys.stdout) 215 | 216 | if args.verbose: 217 | logging_conf(level=logging.DEBUG) 218 | else: 219 | logging_conf(level=logging.INFO) 220 | 221 | # Setting pandas options so it won't throw warnings for no reason 222 | logging.debug('Setting pandas options...') 223 | pd.set_option('mode.chained_assignment', None) 224 | pd.set_option('max_colwidth', 100) # for debug 225 | logging.debug('Finished setting pandas options.') 226 | 227 | # Processing 228 | logging.debug('Starting processing the source data...') 229 | result = process_folder(args.folder, simplify=args.simplify) 230 | logging.debug('Finished processing the source data...') 231 | 232 | # Inferring output fname if not set 233 | output_file = args.output 234 | if not output_file: 235 | logging.debug('Trying to infer the dictionary name...') 236 | try: 237 | with open(os.path.join(args.folder, 'index.json'), encoding='utf-8') as f: 238 | index_json = json.load(f) 239 | output_file = f'{index_json["title"]}.tab' 240 | except: 241 | output_file = 'EPWING.tab' 242 | logging.debug(f'Obtained file name is {output_file}.') 243 | 244 | # Saving the results 245 | logging.info(f'Saving the results to {output_file}...') 246 | result.to_csv(output_file, header=False, index=False, sep='\t', 247 | encoding='utf-8', columns=['word', 'def']) 248 | logging.info(f'Successfully saved the results to {output_file}, ' 249 | 'quitting the program.') 250 | --------------------------------------------------------------------------------