| Name | wkmanager JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | Lib to download wkhtmltopdf/wkhtmltoimage (wkhtmltox) based on OS. |
| upload_time | 2023-08-03 15:36:35 |
| maintainer | |
| docs_url | None |
| author | Ricardo Castro |
| requires_python | >=3.10,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Welcome to WkManager!
An unnoficial lib that facilitates the download of wkhtmltopdf/wkhtmltoimage (wkhtmltox), based on the characteristics of the system such as OS, architecture of the processor and also the availability of the software, also being possible to manually select this information.
# WkManager
A class to validation of system characteristics to start downloading wkhtmltopdf/wkhtmltopdf (wkhtmltox) files from the official website (please consult directly for more information).
### Attributes
| Attribute | Type |
| -------- | ----- |
| sys |**str**|
| support |**str**|
| arch |**str**|
| extension|**str**|
- **system**: the OS you are looking for, if None will be replace by checking your OS.
- **support**: the support are looking for, like "XP", "Vista", "Debian", "Arch. if None wil be replaced by checking your OS.
- **arch**: the OS architecture you are looking for, if None will be replace by checking your machine.
- **extension**: the extension you looking for, if None will raise an ValueError with the avaliable extensions for you based on others attributes.
Example:
```
from wkmanager import WkManager
Wk = WkManager("Windows", "XP", "64bit", "7z")
```
>If successful, you can use the **get_wk** method.
## get_wk
Method to download the wkhtmltox files, being able to unzip it automatically (winrar required for 7z files).
### Args
|Attribute| Type |
| --------|--------------|
| path | **str**|
| extract |**bool**|
| winrar_path | **str**|
- **path**: the path where the file will be saved, if None will saved on root.
- **extract**: if True, the file will be extracted if it is 7z or Zip, by default it is False.
- **winrar_path**: if a 7z file extension is selected and extract is True, it will be necessary to have Winrar installed and pass the path to winrar.exe for the file to be unpacked.
```
from wkmanager import WkManager
Wk = WkManager("Windows", "XP", "64bit", "7z")
wk_path = Wk.get_wk("wk_folder", True, "C:\Program Files\WinRAR\WinRAR.exe")
```
>the if extract is True, the file will be full unpacked without internal folder.
### Returns
Returns the path of folder with wk files.
Raw data
{
"_id": null,
"home_page": "",
"name": "wkmanager",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Ricardo Castro",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ea/36/baae680ee87d25df5f8498863b9abd26cc202918b3c59892f83997d95b6f/wkmanager-0.1.3.tar.gz",
"platform": null,
"description": "\n# Welcome to WkManager!\n\nAn unnoficial lib that facilitates the download of wkhtmltopdf/wkhtmltoimage (wkhtmltox), based on the characteristics of the system such as OS, architecture of the processor and also the availability of the software, also being possible to manually select this information.\n\n# WkManager\n\nA class to validation of system characteristics to start downloading wkhtmltopdf/wkhtmltopdf (wkhtmltox) files from the official website (please consult directly for more information).\n### Attributes\n\n| Attribute | Type |\n| -------- | ----- |\n| sys |**str**|\n| support |**str**|\n| arch |**str**|\n| extension|**str**|\n\n- **system**: the OS you are looking for, if None will be replace by checking your OS.\n\n- **support**: the support are looking for, like \"XP\", \"Vista\", \"Debian\", \"Arch. if None wil be replaced by checking your OS.\n\n- **arch**: the OS architecture you are looking for, if None will be replace by checking your machine.\n\n- **extension**: the extension you looking for, if None will raise an ValueError with the avaliable extensions for you based on others attributes.\n\nExample:\n```\nfrom wkmanager import WkManager\n\nWk = WkManager(\"Windows\", \"XP\", \"64bit\", \"7z\")\n```\n>If successful, you can use the **get_wk** method.\n\n\n## get_wk\n\nMethod to download the wkhtmltox files, being able to unzip it automatically (winrar required for 7z files).\n\n### Args\n\n|Attribute| Type |\n| --------|--------------|\n| path | **str**|\n| extract |**bool**|\n| winrar_path | **str**|\n\n- **path**: the path where the file will be saved, if None will saved on root.\n\n- **extract**: if True, the file will be extracted if it is 7z or Zip, by default it is False.\n\n- **winrar_path**: if a 7z file extension is selected and extract is True, it will be necessary to have Winrar installed and pass the path to winrar.exe for the file to be unpacked.\n\n```\nfrom wkmanager import WkManager\n\nWk = WkManager(\"Windows\", \"XP\", \"64bit\", \"7z\")\nwk_path = Wk.get_wk(\"wk_folder\", True, \"C:\\Program Files\\WinRAR\\WinRAR.exe\")\n```\n\n>the if extract is True, the file will be full unpacked without internal folder.\n\n### Returns\nReturns the path of folder with wk files.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Lib to download wkhtmltopdf/wkhtmltoimage (wkhtmltox) based on OS.",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49029ac8ef6045a1ca069fef8eef904506d85aadd6e83a092c7b485a7c869d19",
"md5": "6575187410021710da035aaa4d5ce037",
"sha256": "1959b2badc21756428f0c4c79e7278548c9a377acdf167c0093a530f9e40dbb6"
},
"downloads": -1,
"filename": "wkmanager-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6575187410021710da035aaa4d5ce037",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 5024,
"upload_time": "2023-08-03T15:36:34",
"upload_time_iso_8601": "2023-08-03T15:36:34.386683Z",
"url": "https://files.pythonhosted.org/packages/49/02/9ac8ef6045a1ca069fef8eef904506d85aadd6e83a092c7b485a7c869d19/wkmanager-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea36baae680ee87d25df5f8498863b9abd26cc202918b3c59892f83997d95b6f",
"md5": "08e8094f4c7bd75252424101d85bef8e",
"sha256": "c06db90a1080acae2ba72903661dffdbc70d0f7136a16d6e1b706e23f638e02d"
},
"downloads": -1,
"filename": "wkmanager-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "08e8094f4c7bd75252424101d85bef8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 4548,
"upload_time": "2023-08-03T15:36:35",
"upload_time_iso_8601": "2023-08-03T15:36:35.428832Z",
"url": "https://files.pythonhosted.org/packages/ea/36/baae680ee87d25df5f8498863b9abd26cc202918b3c59892f83997d95b6f/wkmanager-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-03 15:36:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "wkmanager"
}
