diff --git a/.dockerignore b/.dockerignore index 77a212f..847a35a 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,3 +1,6 @@ +# paper2html/.dockerignore +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 eitsupi .git .github tests diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml index 01b2187..d1391dd 100644 --- a/.github/workflows/docker-publish.yml +++ b/.github/workflows/docker-publish.yml @@ -1,3 +1,6 @@ +# paper2html/.github/workflows/docker-publish.yml +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 eitsupi name: Build and push container on: diff --git a/.gitignore b/.gitignore index 25d2095..3ef45e5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# paper2html/.gitignore +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 ktaaaki + *.pdf !/tests/sample_files/* diff --git a/LICENSE b/LICENSE index 0ad25db..20d40b6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,23 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 - Copyright (C) 2007 Free Software Foundation, Inc. + Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. + The GNU General Public License is a free, copyleft license for +software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to +the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free -software for all its users. +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you @@ -24,34 +26,44 @@ them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. @@ -60,7 +72,7 @@ modification follow. 0. Definitions. - "This License" refers to version 3 of the GNU Affero General Public License. + "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. @@ -537,45 +549,35 @@ to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. + 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single +under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General +Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published +GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's +versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. @@ -633,29 +635,40 @@ the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published - by the Free Software Foundation, either version 3 of the License, or + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. + GNU General Public License for more details. - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . + You should have received a copy of the GNU General Public License + along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/LICENSE_MIT b/LICENSE_MIT new file mode 100644 index 0000000..51eda35 --- /dev/null +++ b/LICENSE_MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 ktaaaki + +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. \ No newline at end of file diff --git a/README.md b/README.md index c5c533a..74cc081 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # paper2html -[![License: AGPL](https://img.shields.io/badge/license-AGPL-yellow)](https://opensource.org/licenses/AGPL-3.0) +[![License: GPLv2+](https://img.shields.io/badge/license-GPLv2+-yellow)](https://opensource.org/licenses/GPL-2.0) [![Python Version](https://img.shields.io/badge/python-3.6|3.7|3.8|3.9-blue)](https://github.com/ktaaaki/paper2html) [![Platform](https://img.shields.io/badge/platform-windows|macos|linux-blue)](https://github.com/ktaaaki/paper2html) @@ -89,7 +89,7 @@ $ python paper2html/commands.py "path-to-paper-file.pdf" In IPython, do it like this. -```py +```pycon >>> import paper2html >>> paper2html.open_paper_htmls("path-to-paper-file.pdf") ``` @@ -102,7 +102,28 @@ $ python paper2html/commands.py "path-to-paper-file.pdf" --browser_path="/path/t You can also only convert without opening a browser. -```py +```pycon >>> import paper2html >>> paper2html.paper2html("path-to-paper-file or directory") ``` + +## External Libraries used by paper2html + +Thank to the following libraries used by paper2html. + +- Poppler is distributrd under the GPLv2+ license. (Copyright 2005-2020 [The Poppler Developers](http://poppler.freedesktop.org) & +Copyright 1996-2011 Glyph & Cog, LLC) +- Pdfminer.six is distributrd under the MIT license. (Copyright © 2004-2016 Yusuke Shinyama ) +- pdf2image is distributrd under the MIT license. (Copyright © 2017 Edouard Belval) +- pillow is distributed under the [PIL](https://github.com/python-pillow/Pillow/blob/master/LICENSE) license. (Copyright © 1997-2011 by Secret Labs AB & Copyright © 1995-2011 by Fredrik Lundh) +- The license of matplotlib is based on the [PSF](https://docs.python.org/3/license.html) license. (Copyright © 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2021 The Matplotlib development team.) +- Flask is licensed under the 3C BSD license. (Copyright © 2016, opentracing-contrib.) +- Watchdog is licensed under the terms of the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0). (Copyright © 2011 Yesudeep Mangalapilly & Copyright 2012 Google, Inc & contributors.) +- Python Fire is Licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0). (Copyright © 2017 Google Inc. All rights reserved.) + + +## License +The entire source code of paper2html is compatible with the GPL v3 or later license. (see LICENSE for details) + +[comment]: <> (The website content is licensed under CC BY 4.0. (see LICENSE).) +[comment]: <> (Copyright (C) 2021 eitsupi) diff --git a/docker/Dockerfile b/docker/Dockerfile index 342e3f2..da1c6c3 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -1,3 +1,8 @@ +# -*- coding:utf-8 -*- +# paper2html/docker/Dockerfile +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 eitsupi + FROM python:slim LABEL org.opencontainers.image.source=https://github.com/ktaaaki/paper2html diff --git a/docker/README.md b/docker/README.md index 090c826..f5b628f 100644 --- a/docker/README.md +++ b/docker/README.md @@ -30,3 +30,5 @@ $ docker run --rm -it -p 5000:5000 -v ${PWD}:/tmp/paper_cache ghcr.io/ktaaaki/pa ``` At present it only works on Linux (`ext4` volume). + +[comment]: <> (Copyright (C) 2021 eitsupi) diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh index f99beef..b9b8f03 100644 --- a/docker/entrypoint.sh +++ b/docker/entrypoint.sh @@ -1,5 +1,9 @@ #!/bin/bash +# paper2html/docker/entrypoint.sh +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 eitsupi + MOUNT_PATH=./paper_cache USER_NAME=paperuser diff --git a/docker/start.sh b/docker/start.sh index 2000d15..b3197c7 100644 --- a/docker/start.sh +++ b/docker/start.sh @@ -1,3 +1,7 @@ #!/bin/bash +# paper2html/docker/start.sh +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 eitsupi + su ${USER_NAME} -c "python ./paper2html/paper2html/main.py --host=0.0.0.0 --watch=True" \ No newline at end of file diff --git a/paper2html/__init__.py b/paper2html/__init__.py index 1f2f912..1e87316 100644 --- a/paper2html/__init__.py +++ b/paper2html/__init__.py @@ -1,3 +1,8 @@ +# -*- coding:utf-8 -*- +# paper2html/paper2html/__init__.py +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 ktaaaki + from .commands import open_paper_htmls, message_for_automator, paper2html from .convert_service import convert_service_run diff --git a/paper2html/commands.py b/paper2html/commands.py index cd2381f..03fff49 100644 --- a/paper2html/commands.py +++ b/paper2html/commands.py @@ -1,4 +1,7 @@ # -*- coding:utf-8 -*- +# paper2html/paper2html/commands.py +# This file is licensed under the GPLv2 or later (see LICENSE for details) +# Copyright (C) 2021 ktaaaki import os from os.path import join as pjoin from shutil import rmtree diff --git a/paper2html/convert_service.py b/paper2html/convert_service.py index 275a4d1..b9f230c 100644 --- a/paper2html/convert_service.py +++ b/paper2html/convert_service.py @@ -1,3 +1,7 @@ +# -*- coding:utf-8 -*- +# paper2html/paper2html/convert_service.py +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 ktaaaki import logging import os diff --git a/paper2html/html_paper.py b/paper2html/html_paper.py index c421d87..3cb9b85 100644 --- a/paper2html/html_paper.py +++ b/paper2html/html_paper.py @@ -1,3 +1,7 @@ +# -*- coding:utf-8 -*- +# paper2html/paper2html/html_paper.py +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 ktaaaki import re import os import math diff --git a/paper2html/local_paper_directory.py b/paper2html/local_paper_directory.py index a7dd1f1..4bf45f6 100644 --- a/paper2html/local_paper_directory.py +++ b/paper2html/local_paper_directory.py @@ -1,3 +1,7 @@ +# -*- coding:utf-8 -*- +# paper2html/paper2html/local_paper_directory.py +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 ktaaaki import math import os import shutil diff --git a/paper2html/main.py b/paper2html/main.py index 5e337a7..a0b2ec3 100644 --- a/paper2html/main.py +++ b/paper2html/main.py @@ -1,3 +1,7 @@ +# -*- coding:utf-8 -*- +# paper2html/paper2html/main.py +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 ktaaaki import argparse from paper2html.convert_service import convert_service_run diff --git a/paper2html/paper.py b/paper2html/paper.py index f286437..261b368 100644 --- a/paper2html/paper.py +++ b/paper2html/paper.py @@ -1,3 +1,7 @@ +# -*- coding:utf-8 -*- +# paper2html/paper2html/paper.py +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 ktaaaki import re import os import math diff --git a/paper2html/paper_miner.py b/paper2html/paper_miner.py index 38dfff4..5c9f3e3 100644 --- a/paper2html/paper_miner.py +++ b/paper2html/paper_miner.py @@ -1,3 +1,7 @@ +# -*- coding:utf-8 -*- +# paper2html/paper2html/paper_miner.py +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 ktaaaki import math import os from pdfminer.converter import PDFPageAggregator diff --git a/paper2html/templates/index.html b/paper2html/templates/index.html index 47cded2..48e170e 100644 --- a/paper2html/templates/index.html +++ b/paper2html/templates/index.html @@ -1,3 +1,8 @@ + diff --git a/paper2html/templates/stylesheet.css b/paper2html/templates/stylesheet.css index 148d9b6..9edf725 100644 --- a/paper2html/templates/stylesheet.css +++ b/paper2html/templates/stylesheet.css @@ -1,3 +1,9 @@ +/* +paper2html/paper2html/templates/stylesheet.css +This file is licensed under the MIT license (see LICENSE_MIT for details) +Copyright (C) 2021 ktaaaki +*/ + html, body { height: 100%; overflow: hidden; diff --git a/paper2html/templates/two_panes_with_patch.html b/paper2html/templates/two_panes_with_patch.html index a18cdc5..3edc0d9 100644 --- a/paper2html/templates/two_panes_with_patch.html +++ b/paper2html/templates/two_panes_with_patch.html @@ -1,3 +1,8 @@ + diff --git a/paper2html/templates/two_panes_with_patch.js b/paper2html/templates/two_panes_with_patch.js index e926547..4e878e0 100644 --- a/paper2html/templates/two_panes_with_patch.js +++ b/paper2html/templates/two_panes_with_patch.js @@ -1,3 +1,7 @@ +//paper2html/paper2html/templates/two_panes_with_patch.js +//This file is licensed under the MIT license (see LICENSE_MIT for details) +//Copyright (C) 2021 ktaaaki + const Zoom = function(rate) { for (let i = 0; i < document.images.length; i++) { document.images[i].width = document.images[i].naturalWidth * rate; diff --git a/paper2html/templates/two_panes_with_zoom.html b/paper2html/templates/two_panes_with_zoom.html index ceef70f..d8916d2 100644 --- a/paper2html/templates/two_panes_with_zoom.html +++ b/paper2html/templates/two_panes_with_zoom.html @@ -1,3 +1,8 @@ + diff --git a/paper2html/templates/two_panes_with_zoom.js b/paper2html/templates/two_panes_with_zoom.js index ab1612a..0c18d48 100644 --- a/paper2html/templates/two_panes_with_zoom.js +++ b/paper2html/templates/two_panes_with_zoom.js @@ -1,3 +1,7 @@ +//paper2html/paper2html/templates/two_panes_with_zoom.js +//This file is licensed under the MIT license (see LICENSE_MIT for details) +//Copyright (C) 2021 ktaaaki + // setup base elements const rightw = document.getElementById('right'); const leftw = document.getElementById('left'); diff --git a/requirements.txt b/requirements.txt index e41e91a..8aea8c9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,7 @@ +# paper2html/requirements.txt +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 ktaaaki + pdf2image==1.14.0 pdfminer.six==20201018 Flask==1.1.2 diff --git a/setup.py b/setup.py index 9fbc90d..80c7e77 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,7 @@ +# -*- coding:utf-8 -*- +# paper2html/setup.py +# This file is licensed under the MIT license (see LICENSE_MIT for details) +# Copyright (C) 2021 ktaaaki import os from os.path import join as pjoin import re @@ -21,12 +25,12 @@ def get_version(*file_paths): name='paper2html', description='PDF paper to html converter', version=get_version("paper2html", "__init__.py"), - license='AGPL', + license='GPLv3+', classifiers=[ 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', - 'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)', + 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', 'Operating System :: Microsoft :: Windows :: Windows 10', 'Operating System :: MacOS :: MacOS X', 'Operating System :: POSIX :: Linux',