| Name | mous3 JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | |
| Summary | Allows head or tail of a file on s3 without downloading the whole file |
| upload_time | 2024-02-01 21:44:34 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. 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 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. For more information, please refer to <https://unlicense.org> |
| keywords |
aws
s3
head
tail
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mous3
A python utility that allows you to print a number of bytes from either the beginning or end of an object stored on AWS S3 without downloading the entire file.
## Features
- **AWS Profile Support**: Optionally specify an AWS profile to use for accessing the S3 bucket, making it easier to work with multiple AWS accounts or configurations.
- **Flexible Byte Range**: Customize the number of bytes you want to read from the end of the object.
## Requirements
- Python 3.6+
- Boto3
## Installation
- `pip install mous3`
- Your AWS credentials will need to be stored in `~/.aws/credentials` or set as environment variables (`AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`).
## Usage
`mous3 [-h] [--bytes BYTES] [--profile PROFILE] {direction} {bucket_name} {key}`
#### Positional arguments:
`direction` The direction to read from the object. Can be "head" or "tail".
`bucket_name` The name of the S3 bucket.
`key` The key of the object in the S3 bucket.
#### Optional arguments:
```
-h, --help show this help message and exit
--bytes BYTES Number of bytes to download. Default is 1000. You do not need to specify positive or negative, as this is determined by the "direction" argument.
--profile PROFILE The AWS profile to use. Optional.
```
## Examples:
- To print the first 1000 bytes (head) of an object using the AWS profile named `myProfile`:
- `mous3 head my-bucket example.log --profile myProfile`
- To print the last 1000 bytes (tail) of an object named `example.log` in the bucket `my-bucket`:
- `mous3 tail my-bucket example.log`
- To print the last 200 bytes of the object:
- `mous3 tail my-bucket example.log --bytes 200`
Raw data
{
"_id": null,
"home_page": "",
"name": "mous3",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "aws,s3,head,tail",
"author": "",
"author_email": "Spencer Smith <spencer@auriasllc.com>",
"download_url": "https://files.pythonhosted.org/packages/9b/6e/17ffd3d7a57975952439228c3f666da85638a6125ee4fdb47f0b7ed1e879/mous3-0.1.2.tar.gz",
"platform": null,
"description": "\n# mous3\nA python utility that allows you to print a number of bytes from either the beginning or end of an object stored on AWS S3 without downloading the entire file.\n\n## Features\n- **AWS Profile Support**: Optionally specify an AWS profile to use for accessing the S3 bucket, making it easier to work with multiple AWS accounts or configurations.\n\n- **Flexible Byte Range**: Customize the number of bytes you want to read from the end of the object.\n\n## Requirements\n- Python 3.6+\n- Boto3\n\n## Installation\n- `pip install mous3`\n\n- Your AWS credentials will need to be stored in `~/.aws/credentials` or set as environment variables (`AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`).\n\n## Usage\n\n`mous3 [-h] [--bytes BYTES] [--profile PROFILE] {direction} {bucket_name} {key}`\n\n#### Positional arguments:\n`direction` The direction to read from the object. Can be \"head\" or \"tail\".\n\n`bucket_name` The name of the S3 bucket.\n\n`key` The key of the object in the S3 bucket.\n\n#### Optional arguments:\n\n```\n-h, --help show this help message and exit\n\n--bytes BYTES Number of bytes to download. Default is 1000. You do not need to specify positive or negative, as this is determined by the \"direction\" argument.\n\n--profile PROFILE The AWS profile to use. Optional.\n```\n \n \n\n## Examples:\n- To print the first 1000 bytes (head) of an object using the AWS profile named `myProfile`:\n - `mous3 head my-bucket example.log --profile myProfile`\n- To print the last 1000 bytes (tail) of an object named `example.log` in the bucket `my-bucket`:\n - `mous3 tail my-bucket example.log`\n- To print the last 200 bytes of the object:\n - `mous3 tail my-bucket example.log --bytes 200`\n",
"bugtrack_url": null,
"license": "This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. 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 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. For more information, please refer to <https://unlicense.org> ",
"summary": "Allows head or tail of a file on s3 without downloading the whole file",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/spencersmith/mous3"
},
"split_keywords": [
"aws",
"s3",
"head",
"tail"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6710c13e37b5cf99e02586238f0e8ac660323dd611ea6164d86d0dfff82ba78",
"md5": "d418c3023ba96532eef5b7b04e85eefb",
"sha256": "7b6985e50f5c3f7d966ce6b4e4d6b11241c602a8552fea52923ef70255c17188"
},
"downloads": -1,
"filename": "mous3-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d418c3023ba96532eef5b7b04e85eefb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5103,
"upload_time": "2024-02-01T21:44:33",
"upload_time_iso_8601": "2024-02-01T21:44:33.052690Z",
"url": "https://files.pythonhosted.org/packages/c6/71/0c13e37b5cf99e02586238f0e8ac660323dd611ea6164d86d0dfff82ba78/mous3-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9b6e17ffd3d7a57975952439228c3f666da85638a6125ee4fdb47f0b7ed1e879",
"md5": "57677ea43275f55fb981dca2ce1961c0",
"sha256": "df975451d766f163c4667261fa333900a302dc68f5ec9d1ed74701421ad31c1d"
},
"downloads": -1,
"filename": "mous3-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "57677ea43275f55fb981dca2ce1961c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4068,
"upload_time": "2024-02-01T21:44:34",
"upload_time_iso_8601": "2024-02-01T21:44:34.542122Z",
"url": "https://files.pythonhosted.org/packages/9b/6e/17ffd3d7a57975952439228c3f666da85638a6125ee4fdb47f0b7ed1e879/mous3-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-01 21:44:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spencersmith",
"github_project": "mous3",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mous3"
}
