Skip to main content

A helper library to transport your data into the (next)cloud

Project description

nephelai logo

nephelai

Actions Status Documentation Status Stable python versions Code style: black

A helper library to upload/download files to/from a password-protected shared nextcloud folder. The link and password are read from your .env to enable project-specific shared folders. Because Nextcloud does not enable chunked uploads for shared folders and your files can hit the size limit, your files are uploaded in chunks if needed and reconstructed after download.

Usage

Create a .env file in your project root. Remember to add this file to your .gitignore and always keep it secure to keep your secrets! Your .env should contain:

NEXTCLOUD_FOLDER_URI="uri_of_the_shared_folder"
NEXTCLOUD_FOLDER_PW="pw_of_the_folder"

Then you can interact with the folder in a variety of ways. Alternatively, you can set this environment variables yourself with your preferred method.

Via CLI:

nephelai upload mytestfile.txt anextcloud/path/thatwillbecreatedifneeded/
nephelai download anextcloud/path/thatwillbecreatedifneeded/mytestfile.txt

You can also upload folders including the file structure:

tests/resources
├── mymatrix.npy
└── subfolder
    └── testfile.txt

Using the upload-with-fs command:

nephelai upload-with-fs tests/resources

Which is just syntactic sugar for:

nephelai upload tests/resources tests/resources

Downloading can be done accordingly:

nephelai download tests

Which will download it to your current directory. You can also specify the download path:

nephelai download tests --local-path /tmp/

This download the folder as:

/tmp/tests
└── resources
    ├── mymatrix.npy
    └── subfolder
        └── testfile.txt

Using

nephelai ls tests

you can show the files in the tests directory.

You can get help for each command via the --help flag.

Via Python:

from nephelai import upload, download

upload("tests/resources", "tests/resources")
file_dl_path = "/tmp/mymatrix.npy"
download("tests/resources/mymatrix.npy",file_dl_path)

import numpy as np

mymatrix = np.load(file_dl_path)

Installation

pip install nephelai

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

nephelai-0.2.0.tar.gz (8.5 kB view hashes)

Uploaded Source

Built Distribution

nephelai-0.2.0-py3-none-any.whl (7.9 kB view hashes)

Uploaded Python 3

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