diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..b58e56c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,64 @@ +name: Bug Report +description: File a bug report +title: "[BUG REPORT]: " +labels: [bug] +assignees: + - 1Danish-00 +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: input + id: os + attributes: + label: Your System? + validations: + required: true + - type: dropdown + id: pyversion + attributes: + label: Version + description: Your Python version? + options: + - latest + - 3.9 + - 3.8 + - 3.7 + - 3.6 + - 3.5 + - 3.x + - 2.x + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: Which version of htmlwebshot are you using? + options: + - latest + - v0.1 + - pre-release + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug!" + validations: + required: true + - type: textarea + id: code + attributes: + label: Paste Your Codes. + description: Paste Your Code + render: python + - type: textarea + id: error + attributes: + label: Your Error Logs. + render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ + diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..491deae --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +version: 2 +updates: +- package-ecosystem: pip + directory: "/" + schedule: + interval: daily + open-pull-requests-limit: 10 diff --git a/.github/workflows/pyLint.yml b/.github/workflows/pyLint.yml new file mode 100644 index 0000000..22b4b8a --- /dev/null +++ b/.github/workflows/pyLint.yml @@ -0,0 +1,31 @@ +name: pyLint +on: push +jobs: + PEP8: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: 3.9 + - name: Install Python lint libraries + run: | + pip install autopep8 autoflake isort black + - name: Check for showstoppers + run: autopep8 --verbose --in-place --recursive --aggressive --aggressive . . + - name: Remove unused imports and variables + run: autoflake --in-place --recursive --remove-all-unused-imports --remove-unused-variables --ignore-init-module-imports . + - name: lint with isort and black + run: | + isort . + black --fast . + # commit changes + - uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: 'pyLint: auto-fixes' + commit_options: '--no-verify' + repository: . + commit_user_name: Danish + commit_user_email: danish@ultroid.tech + commit_author: Danish diff --git a/.github/workflows/py_upload.yml b/.github/workflows/py_upload.yml new file mode 100644 index 0000000..b082532 --- /dev/null +++ b/.github/workflows/py_upload.yml @@ -0,0 +1,26 @@ +name: Upload Package + +on: workflow_dispatch + +jobs: + deploy: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.x' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install build + - name: Build package + run: python -m build + - name: Publish package + uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 + with: + user: __token__ + password: ${{ secrets.PYPI_API_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b6e4761 --- /dev/null +++ b/.gitignore @@ -0,0 +1,129 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + 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 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, +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. 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 +have the freedom to distribute copies of free software (and charge for +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. + + 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. + + TERMS AND CONDITIONS + + 0. Definitions. + + "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. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +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. 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 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 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 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 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 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 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. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +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 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 General Public License for more details. + + 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 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 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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e60361e --- /dev/null +++ b/README.md @@ -0,0 +1,221 @@ +# HtmlWebShot +[![PyPI version](https://badge.fury.io/py/htmlwebshot.svg)](https://badge.fury.io/py/htmlwebshot) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4ffdde720ca542a2973b3a79da61bd70)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=1Danish-00/HtmlWebShot&utm_campaign=Badge_Grade) +[![Licence](https://img.shields.io/github/license/1Danish-00/HtmlWebShot.svg)](https://github.com/1Danish-00/HtmlWebShot/blob/main/LICENSE) + +A python3 package which Can Create Images From url, Html-CSS, Svg and from any readable file and texts with many setup features. + +## Setup & Installation +* Install HtmlWebShot: + ```bash + $ pip3 install htmlwebshot + ``` +* Install wkhtmltopdf: + + * Debian/Ubuntu: + ```bash + $ apt-get install wkhtmltopdf -y + ``` + * MacOs: + ```bash + $ brew install homebrew/cask/wkhtmltopdf + ``` + * Alternative Support + ``` + $ wget https://github.com/1Danish-00/HtmlWebShot/raw/main/script.sh && sh script.sh + ``` + +## Usage + +### Import & Instantiate +```python +from htmlwebshot import WebShot +shot = WebShot() +``` + +##### Multiple Arguments + +* `size`: (int , int) : tuple : height, width default: full-screen +* `quality`: int : (between 0-100) +* `delay`: float : delay time to load page +* `flags`: list : [know More](#flags-uses) +* `params`: dict : [know more](#available-params) +* `config`: path setup [know more](#config-path) + +### Simple Method + +> Using Url +```py +shot.create_pic(url="https://google.com") +``` +> Using Html File +```py +shot.create_pic(html="myfile.html", output="picture.jpg") +``` +> Using Html with CSS + >> via files + ```py + shot.create_pic(html="myfile.html", css="background.css", output="picture.jpg") + ``` + >> via string + ```py + html = """

Hello World

+

Write something about the world.

""" + css = "body {background: pink;} p {color: red;}" + + shot.create_pic(html=html, css=css, output="picture.jpg") + ``` +> Using Svg Or Any Other Readable File/Text +```py +shot.create_pic(other="violin.svg", output="picture.jpg") +``` +```py +text = "What should I write here???" +shot.create_pic(other=text, size=(100,200)) +``` + + +You can use with async too +```py +await shot.create_pic_async( # parameters are same for both +``` + +### Some Examples + +```py +from htmlwebshot import WebShot +shot = WebShot() + +shot.size = (110, 270) +shot.quality = 80 # maximum 100 + +html = """

Hello World

+

Write something about the world.

""" +css = "body {background: pink;} p {color: red;}" + +shot.create_pic(html=html, css=css, output="picture.jpg") +``` +
+ Click Here To See Output Image Of Above Code. +sample1 +
+ +```py +from htmlwebshot import WebShot +shot = WebShot() + +shot.quality = 100 +shot.params = {"--crop-x":300, "--crop-w": 400} + +shot.create_pic(html="profile.html", css="profile.css") +``` +
+ Click Here To See Output Image Of Above Code. +sample2 +
+
+
+ Click For More Examples + +```py +from htmlwebshot import WebShot +shot = WebShot() + +shot.quality = 85 +shot.flags = ["--enable-javascript"] + +shot.create_pic(html="jsgraph.html") +``` + +
+ Click Here To See Output Image Of Above Code. +sample4 +
+ +```py +from kk.htmlwebshot import WebShot +shot = WebShot() + +shot.flags = ["--quiet"] +shot.quality = 100 + +shot.create_pic(other="violin.svg", size=(500,600)) +``` + +
+ Click Here To See Output Image Of Above Code. +sample3 +
+ +
+ +### Flags Uses + +
+ Click Here To Check All Flags: + +* `--quiet`: Be less verbose +* `--disable-smart-width`: To force size to be accurate +* `--custom-header-propagation`: Add HTTP headers specified by flag `--custom-header` for each resource request +* `--no-custom-header-propagation`: Don't Add HTTP headers specified by flag `--custom-header` for each resource request +* `--disable-javascript`: Don't allow web pages to run javascript +* `--enable-javascript`: Allow web pages to run javascript +* `--proxy-hostname-lookup`: Use the proxy for resolving hostnames +* `--stop-slow-scripts`: Stop slow running javascripts +* `--no-stop-slow-scripts`: Don't Stop slow running javascripts +
+ +```py +from htmlwebshot import WebShot +shot = WebShot() +shot.flags = ["--quiet", "--enable-javascript", "--no-stop-slow-scripts"] +``` + +### Available Params + +
+ Click Here To Check All Params options: + +* `--bypass-proxy-for`: _``_ Bypass proxy for host (repeatable) +* `--cookie`: _`` ``_ Set an additional cookie (repeatable), value should be url encoded. +* `--cookie-jar`: _``_ Read and write cookies from and to the supplied cookie jar file +* `--crop-h`: _``_ Set height for cropping +* `--crop-w`: _``_ Set width for cropping +* `--crop-x`: _``_ Set x coordinate for cropping +* `--crop-y`: _``_ Set y coordinate for cropping +* `--custom-header`: _`` ``_ Set an additional HTTP header (repeatable) +* `--encoding`: _``_ Set the default text encoding, for input +* `--format`: _``_ Output file format +* `--minimum-font-size`: _``_ Minimum font size +* `--password`: _``_ HTTP Authentication password +* `--post`: _`` ``_ Add an additional post field (repeatable) +* `--post-file`: _` `_ Post an additional file (repeatable) +* `--proxy`: _``_ Use a proxy +* `--run-script`: _``_ Run this additional javascript after the page is done loading (repeatable) +* `--ssl-crt-path`: _``_ Path to the ssl client cert public key in OpenSSL PEM format, optionally followed by intermediate ca and trusted certs +* `--ssl-key-password`: _``_ Password to ssl client cert private key +* `--ssl-key-path`: _``_ Path to ssl client cert private key in OpenSSL PEM format +* `--user-style-sheet`: _``_ Specify a user style sheet, to load with every page +* `--username`: _``_ HTTP Authentication username +* `--window-status`: _``_ Wait until window.status is equal to this string before rendering page +* `--zoom`: _``_ Use this zoom factor +
+ +```py +from htmlwebshot import WebShot +shot = WebShot() +shot.params = { + "--custom-header": "Accept-Encoding gzip", + "--minimum-font-size": 50, + "--format": "png", + "--zoom": 10, + } +``` + +### Config Path + +```py +from htmlwebshot import WebShot, Config +shot = WebShot() +shot.config = Config(wkhtmltopdf="/path/to/wkhtmltopdf", wkhtmltoimage="/path/to/wkhtmltoimage") +``` diff --git a/example/background.css b/example/background.css new file mode 100644 index 0000000..b61dc77 --- /dev/null +++ b/example/background.css @@ -0,0 +1,11 @@ +body { + background-color: powderblue; +} + +h1 { + color: blue; +} + +p { + color: red; +} diff --git a/example/jsgraph.html b/example/jsgraph.html new file mode 100644 index 0000000..278a1a0 --- /dev/null +++ b/example/jsgraph.html @@ -0,0 +1,26 @@ + + + + + + + +
+ + diff --git a/example/myfile.html b/example/myfile.html new file mode 100644 index 0000000..61c1f9a --- /dev/null +++ b/example/myfile.html @@ -0,0 +1,12 @@ + + + +Page Title + + + +

This is a Heading

+

This is a paragraph.

+ + + diff --git a/example/profile.css b/example/profile.css new file mode 100644 index 0000000..004448a --- /dev/null +++ b/example/profile.css @@ -0,0 +1,36 @@ +.card { + box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2); + max-width: 300px; + margin: auto; + text-align: center; + font-family: Arial, sans-serif; +} + +.title { + color: grey; + font-size: 18px; +} + +button { + border: none; + outline: 0; + display: inline-block; + padding: 8px; + color: white; + background-color: #000; + text-align: center; + cursor: pointer; + width: 100%; + font-size: 18px; +} + +a { + text-decoration: none; + font-size: 22px; + color: black; +} + +button:hover, +a:hover { + opacity: 0.7; +} diff --git a/example/profile.html b/example/profile.html new file mode 100644 index 0000000..41f4cd5 --- /dev/null +++ b/example/profile.html @@ -0,0 +1,25 @@ + + + + + + + +

Magical Profile Card

+ +
+ John +

Harry Potter

+

CEO & Founder, Magical World

+

Hogwarts University

+
+ + + + +
+

+
+ + + diff --git a/example/violin.svg b/example/violin.svg new file mode 100644 index 0000000..6ea11d2 --- /dev/null +++ b/example/violin.svg @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/htmlwebshot/__init__.py b/htmlwebshot/__init__.py new file mode 100644 index 0000000..7015373 --- /dev/null +++ b/htmlwebshot/__init__.py @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +""" +python wrapper to convert any readable file/txt to image using the webkit rendering engine. +""" + +from .config import Config +from .webshot import WebShot diff --git a/htmlwebshot/config.py b/htmlwebshot/config.py new file mode 100644 index 0000000..dbec989 --- /dev/null +++ b/htmlwebshot/config.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- + + +import shutil + + +class Config(object): + + """Config class to configure path of wkhtmltoimage, wkhtmltopdf""" + + def __init__(self, wkhtmltoimage=None, wkhtmltopdf=None): + """To Config Binary Path of wkhtmltopdf & wkhtmltoimage + + parameters:: wkhtmltoimage :: Put Binary Path of file + :: wkhtmltopdf :: put Binary path of file + """ + self.wkhi = wkhtmltoimage + self.wkhp = wkhtmltopdf + + def get_ps(self): + """To get return of configured binary paths + + return :: tuple , (str, str) wkhtmltopdf, wkhtmltoimage path + + raise :: FileNotFoundError :: if Not Configured path or Config path wrong + """ + # Auto configure if files exists on right place like /usr/bin/wkhtmltopdf + # else you have to configure the binary paths + if not self.wkhi: + if shutil.which("wkhtmltoimage"): + self.wkhi = "wkhtmltoimage" + else: + if not shutil.which(self.wkhi): + self.wkhi = None + # well for now wkhtmltopdf not needed , we using wkhtmltoimage + # its for future use... + # And for using wkhtmltoimage we have to install wkhtmltopdf. + if not self.wkhp: + if shutil.which("wkhtmltopdf"): + self.wkhp = "wkhtmltopdf" + else: + if not shutil.which(self.wkhp): + self.wkhp = None + # if configuration success , return binary path + # else raise error + if not self.wkhp: + raise FileNotFoundError( + "pkg wkhtmltopdf not found, Be sure you set correct config" + ) + elif not self.wkhi: + raise FileNotFoundError( + "pkg wkhtmltopdf exist but can't find wkhtmltoimage binary file location, Be sure to set correct config" + ) + else: + return self.wkhp, self.wkhi diff --git a/htmlwebshot/shotter.py b/htmlwebshot/shotter.py new file mode 100644 index 0000000..e3ab48b --- /dev/null +++ b/htmlwebshot/shotter.py @@ -0,0 +1,183 @@ +# -*- coding: utf-8 -*- + +import asyncio +import re +import subprocess +import time + +# optional flags list & details +# https://github.com/1Danish-00/htmlwebshot#flags-uses + +all_flags = [ + "--quiet", # Be less verbose + "--disable-smart-width", # To force size to be accurate + "--custom-header-propagation", # Add HTTP headers for each request. + "--no-custom-header-propagation", # Do not add HTTP headers for each resource + "--disable-javascript", # Do not allow web pages to run javascript + "--enable-javascript", # Do allow web pages to run javascript + "--proxy-hostname-lookup", # Use the proxy for resolving hostnames + "--stop-slow-scripts", # Stop slow running javascripts + "--no-stop-slow-scripts", # Do not Stop slow running javascripts +] + +# optional params details :- +# https://github.com/1Danish-00/htmlwebshot#available-params + +options = [ + "--bypass-proxy-for", + "--cookie", + "--cookie-jar", + "--crop-h", + "--crop-w", + "--crop-x", + "--crop-y", + "--custom-header", + "--encoding", + "--format", + "--minimum-font-size", + "--password", + "--post", + "--post-file", + "--proxy", + "--run-script", + "--ssl-crt-path", + "--ssl-key-password", + "--ssl-key-path", + "--user-style-sheet", + "--username", + "--window-status", + "--zoom", +] + + +class Clickit: + + """class Clickit for setting up commands & processing""" + + def __init__(self): + pass + + @staticmethod + def make_setup( + config=None, + flags=[], + params={}, + quality=None, + delay=None, + size=(None, None), + file=None, + output=None, + ): + """To create command setup as per the input data + + parameters :: config :: configuration of Config class + :: flags :: list :: passed flags + :: params :: dict :: extra options with values + :: quality :: int :: output image quality (1-100) + :: delay :: float :: time to wait for js loading + :: size :: tuple (int, int) :: height & width + :: file :: str :: file + :: output :: str :: saving path + + return :: setup command + """ + setup = [] + setup.append(config) + for flag in flags: + if flag in all_flags: + setup.append(flag) + for flag in list(params.keys()): + if flag in options: + setup.append(flag) + values = str(params[flag]).strip().split() + for value in values: + setup.append(value) + setup.append("--images") + if size[0] and size[1]: + setup.append("--height") + setup.append(str(size[0])) + setup.append("--width") + setup.append(str(size[1])) + if quality: + if quality <= 100 and quality >= 1: + setup.append("--quality") + setup.append(str(quality)) + if delay: + setup.append("--javascript-delay") + setup.append(str(delay)) + setup.append(file) + setup.append(output) + return setup + + def _proc(self, data): + """processing setup data non async + + parameters :: data :: list :: returned from func setup + + return :: output logs + """ + process = subprocess.Popen( + data, stdout=subprocess.PIPE, stderr=subprocess.PIPE + ) # nosec + _, output = process.communicate() + return output.decode().strip() + + def create_stuff(self, *args): + """creating image from args non async + + return :: str :: image path + + raise :: SystemError :: while processing data + """ + data = Clickit.make_setup(*args) + proc = self._proc(data) + if proc: + # issue with wkhtmltoimage + # sometimes can't save on a specific file + # so, for bypass it change name & rename again on main return + if "Could not write to output file" in proc: + data.remove(data[-1]) + data.append(str(time.time()).split(".")[0] + ".jpg") + proc = self._proc(data) + if proc and "Error:" in proc: + raise SystemError(re.findall("Error:(.*)", proc)) + elif re.search("Error:", proc): + raise SystemError(re.findall("Error:(.*)", proc)) + return data[-1] + + async def _sh(self, data): + """running setup data async + + parameters :: data :: list :: returned from func setup + + return :: output logs + """ + process = await asyncio.create_subprocess_exec( + *data, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE + ) # nosec + _, out = await process.communicate() + return out.decode().strip() + + async def create_stuff_async(self, *args): + """creating image from args async + + raise :: SystemError :: while processing data + + return :: str :: image path + + """ + setups = Clickit.make_setup(*args) + err = await self._sh(setups) + if err: + # issue with wkhtmltoimage + # sometimes can't save on a specific file + # so, for bypass it change name & rename again on main return + if "Could not write to output file" in err: + setups.remove(setups[-1]) + setups.append(str(time.time()).split(".")[0] + ".jpg") + err = await self._sh(setups) + if err and "Error:" in err: + raise SystemError(re.findall("Error:(.*)", err)) + elif re.search("Error:", err): + raise SystemError(re.findall("Error:(.*)", err)) + return setups[-1] diff --git a/htmlwebshot/webshot.py b/htmlwebshot/webshot.py new file mode 100644 index 0000000..70b55ea --- /dev/null +++ b/htmlwebshot/webshot.py @@ -0,0 +1,243 @@ +# -*- coding: utf-8 -*- + +import os + +from .config import Config +from .shotter import Clickit + + +class WebShot: + + """main class to pass config and parameters and get return results""" + + def __init__( + self, + flags=[], + size=(None, None), + quality=None, + delay=None, + config=None, + params={}, + ): + self.size = size + self.flags = flags + self.quality = quality + self.delay = delay + self.params = params + self.config = Config() if not config else config + self._cache = None + + # To update & get Config + @property + def config(self): + return self.wkhp, self.wkhi + + @config.setter + def config(self, config): + self.wkhp, self.wkhi = config.get_ps() + + # Get & Set size tuple >> int : int + @property + def size(self): + return self.height, self.width + + @size.setter + def size(self, _size): + self.height, self.width = _size + + # For Settings and deleting Cache + @property + def cache(self): + if self._cache: + return self._cache + return + + @cache.setter + def cache(self, file): + if file: + self._cache = file + + @cache.deleter + def cache(self): + self._cache = None + + def create_html(self, hfile=None, cfile=None, hstr=None, cstr=None): + """creating & combining html with css and saving to cache + + parameters :: hfile :: str :: input html file + :: cfile :: str :: input css file + :: hstr :: str :: input html string + :: cstr :: str :: input css string + + return :: str :: saved cache file + """ + if hfile: + hstr = open(hfile).read() + if cfile: + cstr = open(cfile).read() + new_html = f"""\ + + + + + + {hstr} + + + """ + file = ".html" + with open(file, "w") as f: + f.write(new_html) + f.close() + self.cache = file + self.file = file + + def source_set(self, url=None, html=None, css=None, other=None): + """finding & settings, input files or strings to use + + parameters :: url :: str :: input url + :: html :: str :: html file or strings + :: css :: str :: css file or strings + :: other :: str :: any file or strings + + return :: str :: file/data to be process + """ + if url: + self.file = url + if html and css: + if os.path.isfile(html): + if os.path.isfile(css): + self.create_html(hfile=html, cfile=css) + else: + self.create_html(hfile=html, cstr=css) + else: + if os.path.isfile(css): + self.create_html(hstr=html, cfile=css) + else: + self.create_html(hstr=html, cstr=css) + elif html: + if os.path.isfile(html): + self.file = html + else: + file = ".html" + with open(file, "w") as f: + f.write(str(html)) + f.close() + self.cache = file + self.file = file + elif other: + if os.path.isfile(other): + self.file = other + else: + file = ".text" + with open(file, "w") as f: + f.write(str(other)) + f.close() + self.cache = file + self.file = file + + # output path setup + @property + def output(self): + return self._output + + @output.setter + def output(self, loc): + loc = os.path.abspath(loc) + file = loc.split("/")[-1] + os.makedirs(loc.replace(file, ""), exist_ok=True) + self._output = loc + + def create_pic( + self, + url=None, + html=None, + css=None, + other=None, + size=(None, None), + output=None, + *args, + **kwargs, + ): + """main funcn of class to get image (non async) + + parameters :: url :: str :: input link of webpage + :: html :: str :: file or text (html) + :: css :: str :: file or text (css) + :: other :: str :: file or text (any) + :: size :: tuple (int, int) :: height & width :: default full-screen + :: output :: str :: path to save image + + return :: str :: saved image path + """ + if size[0] and size[1]: + self.size = size + self.output = "webshot.png" if not output else output + self.source_set(url, html, css, other) + path = Clickit().create_stuff( + self.config[1], + self.flags, + self.params, + self.quality, + self.delay, + self.size, + self.file, + self.output, + ) + # cleaning cache if present + if self.cache: + os.remove(self.cache) + del self.cache + # as per issue https://github.com/1Danish-00/htmlwebshot/blob/f1089bfd172c70b31fee76bfb17ea6d013b3a6a3/htmlwebshot/shotter.py#L172 + # need to rename as per output + if path != self.output: + os.rename(path, self.output) + return self.output + + async def create_pic_async( + self, + url=None, + html=None, + css=None, + other=None, + output=None, + size=(None, None), + *args, + **kwargs, + ): + """main async funcn of class to get image from input parameters + + parameters :: url :: str :: input link of webpage + :: html :: str :: file or text (html) + :: css :: str :: file or text (css) + :: other :: str :: file or text (any) + :: size :: tuple (int, int) :: height & width :: default full-screen + :: output :: str :: path to save image + + return :: str :: saved image path + """ + self.source_set(url, html, css, other) + self.output = "webshot.png" if not output else output + if size[0] and size[1]: + self.size = size + result = await Clickit().create_stuff_async( + self.config[1], + self.flags, + self.params, + self.quality, + self.delay, + self.size, + self.file, + self.output, + ) + # as per issue https://github.com/1Danish-00/htmlwebshot/blob/main/htmlwebshot/shotter.py#L172 + # need to rename as per output + if result != self.output: + os.rename(result, self.output) + # cleaning cache if present + if self.cache: + os.remove(self.cache) + del self.cache + return self.output diff --git a/script.sh b/script.sh new file mode 100644 index 0000000..09c711c --- /dev/null +++ b/script.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env sh + +WKHTML2PDF_VERSION='0.12.4' + +sudo apt-get install -y openssl build-essential xorg libssl-dev +wget "https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/${WKHTML2PDF_VERSION}/wkhtmltox-${WKHTML2PDF_VERSION}_linux-generic-amd64.tar.xz" +tar -xJf "wkhtmltox-${WKHTML2PDF_VERSION}_linux-generic-amd64.tar.xz" +cd wkhtmltox +sudo chown root:root bin/wkhtmltopdf +sudo cp -r ./* /usr/ diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..1cd01b6 --- /dev/null +++ b/setup.py @@ -0,0 +1,54 @@ +import setuptools + +with open("README.md", "r", encoding="utf-8") as f: + long_desc = f.read() + +name = "htmlwebshot" +version = "v0.1" +author = "1Danish-00" +author_email = "danish@ultroid.tech" +desc = "Create Image Of Anything. (files/text/urls)" +lic = "GNU AFFERO aa rha posts GENERAL PUBLIC LICENSE (v3)" +url = "https://github.com/1Danish-00/htmlwebshot/" +project_urls = { + "Bug Tracker": "https://github.com/1Danish-00/htmlwebshot/issues", +} +keys = [ + "screenshot", + "url to image", + "html to image", + "css to image", + "svg to image", + "web image", + "Webshot", + "file to image", +] +classifiers = [ + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: OS Independent", +] + +reqs = ["asyncio"] + +setuptools.setup( + name=name, + version=version, + author=author, + author_email=author_email, + description=desc, + long_description=long_desc, + long_description_content_type="text/markdown", + url=url, + project_urls=project_urls, + license=lic, + keywords=keys, + packages=setuptools.find_packages(), + install_requires=reqs, + classifiers=classifiers, + python_requires=">=3.5", +)