https://github.com/drkostas/cloud-filemanager
A high-level filemanager utility for cloud services. Currently only Dropbox is supported.
https://github.com/drkostas/cloud-filemanager
cloud cloud-file-system cloud-manager cloud-storage dropbox dropbox-api
Last synced: 8 months ago
JSON representation
A high-level filemanager utility for cloud services. Currently only Dropbox is supported.
- Host: GitHub
- URL: https://github.com/drkostas/cloud-filemanager
- Owner: drkostas
- License: apache-2.0
- Created: 2022-01-28T13:45:34.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-30T01:47:38.000Z (about 4 years ago)
- Last Synced: 2025-02-01T01:23:17.267Z (about 1 year ago)
- Topics: cloud, cloud-file-system, cloud-manager, cloud-storage, dropbox, dropbox-api
- Language: Python
- Homepage: https://pypi.org/project/cloud-filemanager/
- Size: 26.4 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Cloud Filemanager
[](https://pepy.tech/project/cloud-filemanager)
[](https://github.com/drkostas/cloud-filemanager/master/LICENSE)
[](https://circleci.com/gh/drkostas/cloud-filemanager/tree/master)
A high-level filemanager utility for cloud services. Currently, only Dropbox
is supported. [PYPI Package](https://pypi.org/project/cloud-filemanager/)
## Table of Contents
+ [Using the library](#using)
+ [Installing and using the library](#install_use)
+ [Examples of usage](#examples)
+ [Manually install the library](#manual_install)
+ [Prerequisites](#prerequisites)
+ [Install the requirements](#installing_req)
+ [Run the Unit Tests](#unit_tests)
+ [Continuous Integration](#ci)
+ [Update PyPI package](#pypi)
+ [License](#license)
For a detailed usage example see
[example.py](https://github.com/drkostas/cloud-filemanager/master/example.py).
You will need to create an Api key for your Dropbox account.
[Reference 1](http://99rabbits.com/get-dropbox-access-token/),
[Reference 2](https://dropbox.tech/developers/generate-an-access-token-for-your-own-account)
### Installing and using the library
First, you need to install the library using pip:
```shell
$ pip install cloud_filemanager
```
Then, import it and initialize it like so:
```python
from cloud_filemanager import DropboxCloudManager
cloud_conf = {'type': 'dropbox', 'config': {'api_key': 'your api key'}}
dbx = DropboxCloudManager(config=cloud_conf)
```
If you want to use a yml file to load the configuration, you can use the `CloudConfig` class:
```python
from cloud_filemanager import CloudConfig
import os
config_path = str(os.path.join('confs', 'conf.yml'))
config = CloudConfig(config_src=config_path)
cloud_conf = config.get_cloud_config()
```
Two example YAML files can be found in
the [confs folder](https://github.com/drkostas/cloud-filemanager/blob/master/confs).
For more details on how to use this YAML configuration loader see
this [Readme](https://github.com/drkostas/yaml-config-wrapper/blob/master/README.md).
The currently supported operations are the following:
- Upload, Download, Delete Files
- List directories
**Upload**
```python
with open('my_file.txt', 'rb') as fp:
file_to_upload = fp.read()
dbx.upload_file(file_bytes=file_to_upload, upload_path='/tests/my_file.txt', write_mode='overwrite')
```
**Download**
```python
dbx.download_file(frompath='/tests/my_file.txt', tofile='my_file_downloaded.txt')
```
**Delete**
```python
dbx.delete_file('/tests/my_file.txt')
```
**List Files**
```python
dbx.ls('/tests/')
```
All of these examples can be found
in [example.py](https://github.com/drkostas/cloud-filemanager/tree/blob/master/example.py).
## Manually install the library
These instructions will get you a copy of the project up and running on your local machine for
development and testing purposes.
You need to have a machine with
[anaconda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) installed and
any Bash based shell (e.g. zsh) installed.
```ShellSession
$ conda -V
conda 4.10.1
$ echo $SHELL
/usr/bin/zsh
```
All the installation steps are being handled by
the [Makefile](https://github.com/drkostas/cloud-filemanager/blob/master/Makefile).
First, modify the python version (`min_python`) and everything else you need in
the [settings.ini](https://github.com/drkostas/cloud-filemanager/blob/master/settings.ini).
Then, execute the following commands:
```ShellSession
$ make create_env
$ conda activate cloud_filemanager
$ make dist
```
Now you are ready to use and modify the library.
If you want to run the unit tests, execute the following command:
```ShellSession
$ make tests
```
For the continuous integration, the CircleCI service is being used. For more information you can
check the [setup guide](https://circleci.com/docs/2.0/language-python/).
For any modifications, edit
the [circleci config](https://github.com/drkostas/cloud-filemanager/blob/master/.circleci/config.yml).
This is mainly for future reference for the developers of this project. First,
create a file called `~/.pypirc` with your pypi login details, as follows:
```
[pypi]
username = your_pypi_username
password = your_pypi_password
```
Then, modify the python version (`min_python`), project status (`status`), release version (`version`)
and everything else you need in
the [settings.ini](https://github.com/drkostas/cloud-filemanager/blob/master/settings.ini).
Finally, execute the following commands:
```ShellSession
$ make create_env
$ conda activate cloud_filemanager
$ make release
```
For a dev release, change the `testing_version` and instead of `make release`, run `make release_test`.
This project is licensed under the Apache License - see
the [LICENSE](https://github.com/drkostas/cloud-filemanager/blob/master/LICENSE) file for details.
