Skip to main content

Library used to download files and support sending to S3

Project description

CathD

Version ProjectImage


Features ✨

  • Download Log: The download feature is accompanied by a log for connection speed and remaining time required.
  • send to s3: accompanied by a feature to directly send downloaded files to S3 with the s3fs library.
  • easy use: Simple calls and easy S3FS configuration.

Requirement ⚙️

Installation 🛠️

pip install cathd

How To Usage 🤔

1. Basic use

If you only want to use the download feature and save it locally on your laptop
from cathd import CathD

url = 'https://raw.githubusercontent.com/ryyos/ryyos/refs/heads/main/images/erine/kawaii.jpg'
path = 'data/erine_kawai.jpg'

CathD.download(
    url=url,
    path=path,
    save=True,
)

2. Send to S3 with an external S3FS connection

If you want to send the downloaded file to S3 and you want to use an external S3FS connection, you can enter your S3FS connection into the "s3fs_connection" param.
import s3fs

from cathd import CathD

url = 'https://raw.githubusercontent.com/ryyos/ryyos/refs/heads/main/images/erine/kawaii.jpg'
path = 'data/erine_kawai.jpg'

client_kwargs = {
    "key": "aws_access_key_id",
    "secret": "aws_secret_access_key",
    "endpoint_url": "endpoint_url",
}

s3 = s3fs.core.S3FileSystem(**client_kwargs)

CathD.download(
    url=url,
    path=path,
    save=True,
    send_s3=True,
    s3fs_connection=s3
)

3. Send to S3 with an internal S3FS connection

If you want to send the downloaded file to the S3 with an internal connection or use the function from CathD to establish a connection to the S3, you can also do it like this
from cathd import CathD

url = 'https://raw.githubusercontent.com/ryyos/ryyos/refs/heads/main/images/erine/kawaii.jpg'
path = 'data/erine_kawai.jpg'

CathD.build_s3fs(
    access_key_id="aws_access_key_id",
    secret_access_key="aws_secret_access_key",
    endpoint_url="endpoint_url",
    bucket="bucket"
)

CathD.download(
    url=url,
    path=path,
    save=True,
    send_s3=True,
)

🚀Structure

├── cathd
│   ├── CathD.py
│   ├── __init__.py
│   └── utils.py
├── LICENSE
├── README.md
└── setup.py

Author

👤 Rio Dwi Saputra

Ryo's LinkedIn Ryo's Instagram

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

CathD-0.0.1.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

CathD-0.0.1-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file CathD-0.0.1.tar.gz.

File metadata

  • Download URL: CathD-0.0.1.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.2

File hashes

Hashes for CathD-0.0.1.tar.gz
Algorithm Hash digest
SHA256 f48dacbe780376a82b4d9d1ae7c001e060913cb01bee6a03a4b09ee88d12426d
MD5 b765ec8ce86e9183de089ffb145ef8f4
BLAKE2b-256 4b5f28626044be6797eecee606e5f2ac1fa2251d57ae9142009701124cc34b04

See more details on using hashes here.

File details

Details for the file CathD-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: CathD-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.2

File hashes

Hashes for CathD-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d97dc9e909b20120bd26db9e55194e874ae5c64bf0ae990e730382a341aa4316
MD5 09fdf24d84a50d0e0352f36f8addbf96
BLAKE2b-256 8963d913cac56b306dada2a4f851ec2cc2e32cdcbafc35ac5c2ff2597a4c926a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page