<a name="top"></a>
<a name="overview"></a>
# Overview
This module wraps around the get method for the python requests library.
I'm only using it to download files for now.
The reason for this package is for me to reuse it across all my projects.
I'll likely build upon it in the future.
# Prerequisites:
- Python 2.7+
# Installation
* From pypi: `pip3 install btweb`
* From this git repo: `pip3 install git+https://github.com/berttejeda/bert.webadapter.git`<br />
Note: To install a specific version of the library from this git repo, <br />
suffix the git URL in the above command with @{ tag name }, e.g.: <br />
git+https://github.com/berttejeda/bert.webadapter.git@0.0.1
# Usage Examples
## Download a file from a URL using Basic HTTP Authentication
```python
from btweb import WebAdapter
webadapter = WebAdapter()
res = webadapter.get(url,
username=username,
password=password)
```
## Download a file from a URL using Basic HTTP Authentication, caching the result for 30 minutes
```python
from btweb import WebAdapter
webadapter = WebAdapter()
res = webadapter.get(url,
username=username,
password=password,
cache=True,
cache_path='.',
cache_time=30)
```
# Keyword Args
```
Keyword | Type | Possible Values | Effect | Example
-------------------------------------------- | ----------------------- | --------------------------------------------------------------
fail_on_errors | bool | [True, False] | Raise an error instead | webadapter = WebAdapter(fail_on_errors=True)
| | of ignoring and |
| | returning 'None' or empty string |
```
Raw data
{
"_id": null,
"home_page": "https://github.com/berttejeda/bert.webadapter.git",
"name": "btweb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": "",
"keywords": "requests,https,get,python,remote,file,download",
"author": "Engelbert Tejeda",
"author_email": "berttejeda@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fc/4c/430ca6efd481e8329155f4ff4d4a36bd4929d79c92674a20a894caa0c492/btweb-0.1.2.tar.gz",
"platform": null,
"description": "<a name=\"top\"></a>\n<a name=\"overview\"></a>\n\n# Overview\n\nThis module wraps around the get method for the python requests library.\n\nI'm only using it to download files for now.\n\nThe reason for this package is for me to reuse it across all my projects.\n\nI'll likely build upon it in the future.\n\n# Prerequisites:\n\n- Python 2.7+\n\n# Installation\n\n* From pypi: `pip3 install btweb`\n* From this git repo: `pip3 install git+https://github.com/berttejeda/bert.webadapter.git`<br />\n Note: To install a specific version of the library from this git repo, <br />\n suffix the git URL in the above command with @{ tag name }, e.g.: <br />\n git+https://github.com/berttejeda/bert.webadapter.git@0.0.1\n\n# Usage Examples\n\n## Download a file from a URL using Basic HTTP Authentication\n\n```python\n\nfrom btweb import WebAdapter\n\nwebadapter = WebAdapter()\nres = webadapter.get(url, \n username=username,\n password=password)\n```\n\n## Download a file from a URL using Basic HTTP Authentication, caching the result for 30 minutes\n\n```python\n\nfrom btweb import WebAdapter\n\nwebadapter = WebAdapter()\nres = webadapter.get(url, \n username=username,\n password=password, \n cache=True,\n cache_path='.',\n cache_time=30)\n```\n\n# Keyword Args\n\n```\nKeyword | Type | Possible Values | Effect | Example\n-------------------------------------------- | ----------------------- | --------------------------------------------------------------\nfail_on_errors | bool | [True, False] | Raise an error instead | webadapter = WebAdapter(fail_on_errors=True)\n | | of ignoring and |\n | | returning 'None' or empty string |\n```\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Utility library for fronting requests functionality",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/berttejeda/bert.webadapter.git"
},
"split_keywords": [
"requests",
"https",
"get",
"python",
"remote",
"file",
"download"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef644182e8ca4968a8a23c9403297b2f8e02192cf4da15256c7fd6971c508554",
"md5": "26629d554613e65a3d989f19882b085d",
"sha256": "66469df04407de2be37539e3b76a8ef2253ab2b7e058fe02605455aae18be2c8"
},
"downloads": -1,
"filename": "btweb-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26629d554613e65a3d989f19882b085d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7",
"size": 3791,
"upload_time": "2023-06-09T20:27:28",
"upload_time_iso_8601": "2023-06-09T20:27:28.371221Z",
"url": "https://files.pythonhosted.org/packages/ef/64/4182e8ca4968a8a23c9403297b2f8e02192cf4da15256c7fd6971c508554/btweb-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc4c430ca6efd481e8329155f4ff4d4a36bd4929d79c92674a20a894caa0c492",
"md5": "37a977703966e054dd2b12c34fa335ba",
"sha256": "008ff3ce308d835ccc5aed562c58e727b04a5c66f202dda8d7db6c61f144d029"
},
"downloads": -1,
"filename": "btweb-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "37a977703966e054dd2b12c34fa335ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 5648,
"upload_time": "2023-06-09T20:27:29",
"upload_time_iso_8601": "2023-06-09T20:27:29.933053Z",
"url": "https://files.pythonhosted.org/packages/fc/4c/430ca6efd481e8329155f4ff4d4a36bd4929d79c92674a20a894caa0c492/btweb-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-09 20:27:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "berttejeda",
"github_project": "bert.webadapter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "btweb"
}
JSON
