Atlas AWS Auto Download
A Python tool for automatically downloading BGI sequencing data from AWS S3 bucket with configuration file support.
Features
- 🔬 BGI Specific: Optimized for downloading BGI sequencing data from AWS S3
- 🔐 Secure: Supports AWS access keys and region configuration
- 📁 Flexible: Configurable S3 bucket and folder paths for different projects
- 📝 Logging: Comprehensive logging of all download operations
- 🚀 Progress: Visual progress bars for large sequencing data downloads
- ⚙️ Configurable: Simple configuration file format for BGI project settings
- 📊 Batch Processing: Efficiently handles multiple sequencing files and directories
Installation
From PyPI (Recommended)
pip install atlas-aws-autodownload
From Source
git clone https://github.com/yourusername/atlas-aws-autodownload.git
cd atlas-aws-autodownload
pip install -e .
Usage
Command Line Interface
After installation, you can use the atlas-aws-download command to download BGI sequencing data:
# Download to current directory
atlas-aws-download bgi_config.txt
# Download to specific directory
atlas-aws-download bgi_config.txt -o ./sequencing_data
# Download specific project data
atlas-aws-download project_config.txt -o ./projects/BGI_2024
Command Line Help
$ atlas-aws-download -h
Python API
from atlas_aws_autodownload import aws_download
# Download BGI sequencing data
aws_download("bgi_config.txt", "./sequencing_data")
# Download specific project
aws_download("project_config.txt", "./projects/BGI_Project_2024")
Configuration File Format
Create a configuration file with the following format for BGI sequencing data:
Project:***
Alias ID:***
S3 Bucket:***
Account:***
Password:***
Region:***
Aws_access_key_id:***
Aws_secret_access_key:***
Note:
- The tool also supports
s3://URI format in the configuration file - For BGI projects, typically use
ap-southeast-1region (Singapore) - Project names usually follow BGI naming conventions
Note: The tool also supports s3:// URI format in the configuration file.
Requirements
- Python 3.7+
- boto3 (for AWS S3 access)
- tqdm (for progress bars)
Typical Use Cases
- BGI Sequencing Data: Download raw sequencing data from BGI's AWS S3 storage
- Project Management: Organize downloads by project, sample, or experiment
- Batch Processing: Handle multiple sequencing runs and data types
- Data Transfer: Efficiently transfer large sequencing datasets to local storage
License
This project is licensed under the MIT License - see the LICENSE file for details.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Support
If you encounter any issues or have questions, please:
- Check the Issues page
- Create a new issue if your problem isn't already reported
- Contact the maintainers at your.email@example.com
Changelog
Version 1.0.0
- Initial release
- Basic S3 download functionality
- Configuration file support
- Command line interface
- Progress bars and logging
Metadata
Release files for atlas-aws-autodownload 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| atlas_aws_autodownload-1.0.3.tar.gz | 9.7 kB | Without provenance | Details for atlas_aws_autodownload-1.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| atlas_aws_autodownload-1.0.3-py3-none-any.whl | Python 3 | none | any | Details for atlas_aws_autodownload-1.0.3-py3-none-any.whl |
Total release size: 20.0 kB
Release files / atlas_aws_autodownload-1.0.3.tar.gz
| Download URL | atlas_aws_autodownload-1.0.3.tar.gz |
|---|---|
| Size | 9.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b5f8501fe09ffd0424034efe4c824a46bebda4965add3fcdcc184075cbf043d4
|
|
BLAKE2b-256 checksum How to use checksums |
4ade0251b9b3b5d2844827a98f8cdec797a0cc4fd295b0ef94f50acc2a47e856
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Release files / atlas_aws_autodownload-1.0.3-py3-none-any.whl
| Download URL | atlas_aws_autodownload-1.0.3-py3-none-any.whl |
|---|---|
| Size | 10.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
14c5f8aaaeb06c25e583683f9063ed3b84f8bfa16270a3be7cd58f1144805145
|
|
BLAKE2b-256 checksum How to use checksums |
de247b81355eb7391cc862f7fa2e2ddab1118b9c9bc2e38895747dc7f24da28f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Security for atlas-aws-autodownload 1.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.