| Name | PyS3Uploader JSON |
| Version |
0.2.3
JSON |
| download |
| home_page | None |
| Summary | Python module to upload objects to an S3 bucket. |
| upload_time | 2025-10-14 00:52:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT License
Copyright (c) 2025 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 |
boto3
python-dotenv
tqdm
|
| 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]
# PyS3Uploader
Python module to upload an entire directory to an S3 bucket.
### Installation
```shell
pip install PyS3Uploader
```
### Usage
##### Upload objects in parallel
```python
import s3
if __name__ == '__main__':
wrapper = s3.Uploader(
bucket_name="BUCKET_NAME",
upload_dir="FULL_PATH_TO_UPLOAD",
exclude_prefix="PART_OF_UPLOAD_DIR_TO_EXCLUDE"
)
wrapper.run_in_parallel()
```
##### Upload objects in sequence
```python
import s3
if __name__ == '__main__':
wrapper = s3.Uploader(
bucket_name="BUCKET_NAME",
upload_dir="FULL_PATH_TO_UPLOAD",
exclude_prefix="PART_OF_UPLOAD_DIR_TO_EXCLUDE"
)
wrapper.run()
```
#### Mandatory arg
- **bucket_name** - Name of the s3 bucket.
- **upload_dir** - Directory to upload.
#### Optional kwargs
- **s3_prefix** - S3 object prefix for each file. Defaults to ``None``
- **exclude_prefix** - Path in ``upload_dir`` that has to be excluded in object keys. Defaults to `None`
- **skip_dot_files** - Boolean flag to skip dot files. Defaults to ``True``
- **overwrite** - Boolean flag to overwrite files present in S3. Defaults to ``False``
- **file_exclusion** - Sequence of files to exclude during upload. Defaults to ``None``
- **folder_exclusion** - Sequence of directories to exclude during upload. Defaults to ``None``
- **logger** - Bring your own custom pre-configured logger. Defaults to on-screen logging.
- **env_file** – Path to a `.env` file for loading environment variables. Defaults to scanning the current 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][label-pypi-package]][pypi-repo]
[https://pypi.org/project/PyS3Uploader/][pypi]
## Runbook
[![made-with-sphinx-doc][label-sphinx-doc]][sphinx]
[https://thevickypedia.github.io/PyS3Uploader/][runbook]
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][license]
[license]: https://github.com/thevickypedia/PyS3Uploader/blob/main/LICENSE
[release-notes]: https://github.com/thevickypedia/PyS3Uploader/blob/main/release_notes.rst
[pypi]: https://pypi.org/project/PyS3Uploader/
[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/PyS3Uploader
[gha-pages-badge]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/pages/pages-build-deployment/badge.svg
[gha-pypi-badge]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/python-publish.yml/badge.svg
[gha-pages]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/pages/pages-build-deployment
[gha-pypi]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/python-publish.yml
[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
[label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx
[runbook]: https://thevickypedia.github.io/PyS3Uploader/
[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-PyS3Uploader-blue?style=for-the-badge&logo=Python
[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
Raw data
{
"_id": null,
"home_page": null,
"name": "PyS3Uploader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "s3",
"author": null,
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": null,
"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# PyS3Uploader\nPython module to upload an entire directory to an S3 bucket.\n\n### Installation\n```shell\npip install PyS3Uploader\n```\n\n### Usage\n\n##### Upload objects in parallel\n```python\nimport s3\n\nif __name__ == '__main__':\n wrapper = s3.Uploader(\n bucket_name=\"BUCKET_NAME\",\n upload_dir=\"FULL_PATH_TO_UPLOAD\",\n exclude_prefix=\"PART_OF_UPLOAD_DIR_TO_EXCLUDE\"\n )\n wrapper.run_in_parallel()\n```\n\n##### Upload objects in sequence\n```python\nimport s3\n\nif __name__ == '__main__':\n wrapper = s3.Uploader(\n bucket_name=\"BUCKET_NAME\",\n upload_dir=\"FULL_PATH_TO_UPLOAD\",\n exclude_prefix=\"PART_OF_UPLOAD_DIR_TO_EXCLUDE\"\n )\n wrapper.run()\n```\n\n#### Mandatory arg\n- **bucket_name** - Name of the s3 bucket.\n- **upload_dir** - Directory to upload.\n\n#### Optional kwargs\n- **s3_prefix** - S3 object prefix for each file. Defaults to ``None``\n- **exclude_prefix** - Path in ``upload_dir`` that has to be excluded in object keys. Defaults to `None`\n- **skip_dot_files** - Boolean flag to skip dot files. Defaults to ``True``\n- **overwrite** - Boolean flag to overwrite files present in S3. Defaults to ``False``\n- **file_exclusion** - Sequence of files to exclude during upload. Defaults to ``None``\n- **folder_exclusion** - Sequence of directories to exclude during upload. Defaults to ``None``\n- **logger** - Bring your own custom pre-configured logger. Defaults to on-screen logging.\n- **env_file** \u2013 Path to a `.env` file for loading environment variables. Defaults to scanning the current 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][label-pypi-package]][pypi-repo]\n\n[https://pypi.org/project/PyS3Uploader/][pypi]\n\n## Runbook\n[![made-with-sphinx-doc][label-sphinx-doc]][sphinx]\n\n[https://thevickypedia.github.io/PyS3Uploader/][runbook]\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][license]\n\n[license]: https://github.com/thevickypedia/PyS3Uploader/blob/main/LICENSE\n[release-notes]: https://github.com/thevickypedia/PyS3Uploader/blob/main/release_notes.rst\n[pypi]: https://pypi.org/project/PyS3Uploader/\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/PyS3Uploader\n[gha-pages-badge]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/pages/pages-build-deployment/badge.svg\n[gha-pypi-badge]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/python-publish.yml/badge.svg\n[gha-pages]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/pages/pages-build-deployment\n[gha-pypi]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/python-publish.yml\n[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html\n[label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx\n[runbook]: https://thevickypedia.github.io/PyS3Uploader/\n[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-PyS3Uploader-blue?style=for-the-badge&logo=Python\n[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Vignesh Rao\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Python module to upload objects to an S3 bucket.",
"version": "0.2.3",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/PyS3Uploader/issues",
"Docs": "https://thevickypedia.github.io/PyS3Uploader/",
"Homepage": "https://github.com/thevickypedia/PyS3Uploader",
"Source": "https://github.com/thevickypedia/PyS3Uploader"
},
"split_keywords": [
"s3"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cc932b3ed66731d3fe4bcb33fbf45cef2f994daaa0149c45fbac33cd397423a6",
"md5": "900b79ee757c1329d616e1619eb2c3cf",
"sha256": "6925af630295299a29826aee0d695ac2d8625bcb92693dc217d0687b70d996a0"
},
"downloads": -1,
"filename": "pys3uploader-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "900b79ee757c1329d616e1619eb2c3cf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 13146,
"upload_time": "2025-10-14T00:52:13",
"upload_time_iso_8601": "2025-10-14T00:52:13.842163Z",
"url": "https://files.pythonhosted.org/packages/cc/93/2b3ed66731d3fe4bcb33fbf45cef2f994daaa0149c45fbac33cd397423a6/pys3uploader-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-14 00:52:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "PyS3Uploader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "boto3",
"specs": [
[
"==",
"1.40.*"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.1.*"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.67.*"
]
]
}
],
"lcname": "pys3uploader"
}
