| Name | s3-downloader JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | Python module to download objects in an S3 bucket. |
| upload_time | 2024-02-29 05:28:10 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2021 Vignesh Rao 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. |
| keywords |
s3
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
**Versions Supported**
**Language Stats**
**Repo Stats**
[][license]
[][repo]
[][repo]
**Activity**
[][repo]
[][repo]
[][repo]
**Build Status**
[![pypi-publish][gha-pypi-badge]][gha-pypi]
[![pages-build-deployment][gha-pages-badge]][gha-pages]
# S3 Download
Python module to download objects in an S3 bucket.
### Installation
```shell
pip install s3-downloader
```
### Usage
##### Download objects in parallel
```python
import s3
if __name__ == '__main__':
wrapper = s3.Downloader(bucket_name='BUCKET_NAME')
wrapper.run_in_parallel(threads=10) # Defaults to 5
```
##### Download objects in sequence
```python
import s3
if __name__ == '__main__':
wrapper = s3.Downloader(bucket_name='BUCKET_NAME')
wrapper.run()
```
#### Mandatory arg
- **bucket_name** - Name of the s3 bucket.
#### Optional kwargs
- **prefix** - Prefix to filter the objects based on their path. Defaults to `None`
- **logger** - Bring your own custom pre-configured logger. Defaults to on-screen logging.
- **download_dir** - Name/path of the directory where the objects have to be stored.
Defaults to `bucket_name` at current working directory.
<br><br>
- **region_name** - AWS region name. Defaults to the env var `AWS_DEFAULT_REGION`
- **profile_name** - AWS profile name. Defaults to the env var `PROFILE_NAME`
- **aws_access_key_id** - AWS access key ID. Defaults to the env var `AWS_ACCESS_KEY_ID`
- **aws_secret_access_key** - AWS secret access key. Defaults to the env var `AWS_SECRET_ACCESS_KEY`
> AWS values are loaded from env vars or the default config at `~/.aws/config` / `~/.aws/credentials`
### Coding Standards
Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>
Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>
Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and
[`isort`](https://pycqa.github.io/isort/)
## [Release Notes][release-notes]
**Requirement**
```shell
python -m pip install gitverse
```
**Usage**
```shell
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
```
## Linting
`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL
markdown files (including Wiki pages)
**Requirement**
```shell
pip install sphinx==5.1.1 pre-commit recommonmark
```
**Usage**
```shell
pre-commit run --all-files
```
### Pypi Package
[![pypi-module][pypi-logo]][pypi-tutorials]
[https://pypi.org/project/s3-downloader/][pypi]
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][license]
[license]: https://github.com/thevickypedia/s3-downloader/blob/main/LICENSE
[release-notes]: https://github.com/thevickypedia/s3-downloader/blob/main/release_notes.rst
[pypi]: https://pypi.org/project/s3-downloader/
[pypi-tutorials]: https://packaging.python.org/tutorials/packaging-projects/
[pypi-logo]: https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg
[repo]: https://api.github.com/repos/thevickypedia/s3-downloader
[gha-pages-badge]: https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment/badge.svg
[gha-pypi-badge]: https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml/badge.svg
[gha-pages]: https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment
[gha-pypi]: https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml
Raw data
{
"_id": null,
"home_page": "",
"name": "s3-downloader",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "s3",
"author": "",
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": "",
"platform": null,
"description": "**Versions Supported**\n\n\n\n**Language Stats**\n\n\n\n\n**Repo Stats**\n\n[][license]\n[][repo]\n[][repo]\n\n**Activity**\n\n[][repo]\n[][repo]\n[][repo]\n\n**Build Status**\n\n[![pypi-publish][gha-pypi-badge]][gha-pypi]\n[![pages-build-deployment][gha-pages-badge]][gha-pages]\n\n# S3 Download\nPython module to download objects in an S3 bucket.\n\n### Installation\n```shell\npip install s3-downloader\n```\n\n### Usage\n\n##### Download objects in parallel\n```python\nimport s3\n\nif __name__ == '__main__':\n wrapper = s3.Downloader(bucket_name='BUCKET_NAME')\n wrapper.run_in_parallel(threads=10) # Defaults to 5\n```\n\n##### Download objects in sequence\n```python\nimport s3\n\nif __name__ == '__main__':\n wrapper = s3.Downloader(bucket_name='BUCKET_NAME')\n wrapper.run()\n```\n\n#### Mandatory arg\n- **bucket_name** - Name of the s3 bucket.\n\n#### Optional kwargs\n- **prefix** - Prefix to filter the objects based on their path. Defaults to `None`\n- **logger** - Bring your own custom pre-configured logger. Defaults to on-screen logging.\n- **download_dir** - Name/path of the directory where the objects have to be stored.\nDefaults to `bucket_name` at current working directory.\n<br><br>\n- **region_name** - AWS region name. Defaults to the env var `AWS_DEFAULT_REGION`\n- **profile_name** - AWS profile name. Defaults to the env var `PROFILE_NAME`\n- **aws_access_key_id** - AWS access key ID. Defaults to the env var `AWS_ACCESS_KEY_ID`\n- **aws_secret_access_key** - AWS secret access key. Defaults to the env var `AWS_SECRET_ACCESS_KEY`\n> AWS values are loaded from env vars or the default config at `~/.aws/config` / `~/.aws/credentials`\n\n### Coding Standards\nDocstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>\nStyling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>\nClean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and\n[`isort`](https://pycqa.github.io/isort/)\n\n## [Release Notes][release-notes]\n**Requirement**\n```shell\npython -m pip install gitverse\n```\n\n**Usage**\n```shell\ngitverse-release reverse -f release_notes.rst -t 'Release Notes'\n```\n\n## Linting\n`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL\nmarkdown files (including Wiki pages)\n\n**Requirement**\n```shell\npip install sphinx==5.1.1 pre-commit recommonmark\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n### Pypi Package\n[![pypi-module][pypi-logo]][pypi-tutorials]\n\n[https://pypi.org/project/s3-downloader/][pypi]\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][license]\n\n[license]: https://github.com/thevickypedia/s3-downloader/blob/main/LICENSE\n[release-notes]: https://github.com/thevickypedia/s3-downloader/blob/main/release_notes.rst\n[pypi]: https://pypi.org/project/s3-downloader/\n[pypi-tutorials]: https://packaging.python.org/tutorials/packaging-projects/\n[pypi-logo]: https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg\n[repo]: https://api.github.com/repos/thevickypedia/s3-downloader\n[gha-pages-badge]: https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment/badge.svg\n[gha-pypi-badge]: https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml/badge.svg\n[gha-pages]: https://github.com/thevickypedia/s3-downloader/actions/workflows/pages/pages-build-deployment\n[gha-pypi]: https://github.com/thevickypedia/s3-downloader/actions/workflows/python-publish.yml\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 Vignesh Rao 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. ",
"summary": "Python module to download objects in an S3 bucket.",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/s3-downloader/issues",
"Docs": "https://thevickypedia.github.io/s3-downloader/",
"Homepage": "https://github.com/thevickypedia/s3-downloader",
"Source": "https://github.com/thevickypedia/s3-downloader"
},
"split_keywords": [
"s3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e85241ded5c43f09f963387fcc054f1c8a609d0838a98485beb19e6cf57b72df",
"md5": "025d6153f285339f738cacae08a20d30",
"sha256": "b5989f288c15c18db5a2bb3f9d6b22b84a21eb4e2636807f052a7a2df436b6ad"
},
"downloads": -1,
"filename": "s3_downloader-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "025d6153f285339f738cacae08a20d30",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8810,
"upload_time": "2024-02-29T05:28:10",
"upload_time_iso_8601": "2024-02-29T05:28:10.507651Z",
"url": "https://files.pythonhosted.org/packages/e8/52/41ded5c43f09f963387fcc054f1c8a609d0838a98485beb19e6cf57b72df/s3_downloader-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 05:28:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "s3-downloader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "s3-downloader"
}
