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/kawaiii.jpeg'
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/kawaiii.jpeg'
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/kawaiii.jpeg'
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.6.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: CathD-0.0.6.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for CathD-0.0.6.tar.gz
Algorithm Hash digest
SHA256 4d5d0af5d0a89c2524c3b5af12a993c3b3eeb7d1de74c36584e685540636a707
MD5 cf2279eb7f69eef050b319b021edefc2
BLAKE2b-256 863e863d2f249fa170cfb8310aa48826243c7e0f4e64589b9204504f0a708218

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for CathD-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ac97ae8e088a0d12d710eda2da5652ecda40295699295a62c8dea8ee99afdf93
MD5 9e77b96ace7bcdfb3866570481c2c869
BLAKE2b-256 ac865cc8a454870bee1374565cf6890d0b0ce6c273f9bad57e574c123a97811d

See more details on using hashes here.

Supported by

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