An MIT licensed python client for Digital Ocean Spaces with a built in shell.
Project description
digital-ocean-spaces
An MIT licensed python client for Digital Ocean Spaces with a built in shell
TLDR
The client connects to a Digital Ocean region and can list files/directors and download/upload files. It has a built in terminal shell for verbose commands and navigation, <- Not yet finished.
ABOUT
Inspired by Python3-DigitalOcean-Spaces-Manager-v2-Advanced. An API client was needed for a commercial project and that package was the best contender. Abandoned, riddled with issues and lacking any license for distro and modificaiton, digital_ocean_spaces was built from scratch with an MIT license. Use it, share it and most of all, feel free to modify it, and contribute back.
The digital-ocean-spaces package provides a nearly stress free 'Client' class that boto3 to help you connect to Digital Ocean spaces. All it needs is your keys and the name of the server to connect to. Once authorized, the client will hopefuly help you figure out what you're doing wrong.
Once you have an authorized client ( server name, public key, secret key,) you should be able to implement it into your existing application like normal.
Alternatively, if you want to stay in the console and use verbose commands, you can run .shell() <- Not yet finished.
QUICKSTART
INSTALL
Console
$ pip install digital-ocean-spaces
or...
$ pip install git+git@github.com:ChariotDev/digital-ocean-spaces.git
USE EXAMPLE
# main.py
from spaces import Client
client = Client(
region_name = 'sfo3', # Required
space_name = 'my_media', # Optional, can be set in spaces/env.yaml and/or be updated with <client>.set_space(space_name)
public_key = 'foo', # Required, but can set key in spaces/env.yaml
secret_key = 'bar', # Required, but can set key in spaces/env.yaml
# If region_name, public_key or secret_key are not provided, Client will override all values
)
LIST AVAILABLE SPACES
# main.py
## Returns raw response content json
client.list_spaces()
## Readable version
print(
client.list_spaces(
string=True # Returns a fancy string
)
)
LIST ALL AVAILABLE FILES
# main.py
## Returns raw response content json
client.list_files(
space_name=None # Optional if a space is already set
)
## Readable version
print(
client.list_spaces(
space_name=None # Optional if a space is already set
string=True # Returns a fancy string
)
)
DOWNLOAD FILE
# main.py
client.download_file(
file_name='foo/bar.txt'
destination='downloads/' # Optional, should use a useful directory
space_name=None # Optional if a space is already set
)
# Download to -> downloads/foo/bar.txt
UPLOAD FILE
# main.py
client.upload_file(
file='my/pc/foo/bar.txt'
destination='foo/' # Optional, should use a useful directory
rename=None # Optional, file name only, no paths or extentions
space_name=None # Optional if a space is already set
)
# Upload to -> foo/bar.txt
VERBOSE SHELL
console
$ client.shell()
TECHNICAL
CLIENT FUNCTIONS
# Creates a Client object
Client<.__init__>(self, region_name=None, space_name=None, public_key=None, secret_key=None)
# Updates and stores available spaces
Client.refresh_spaces()
# Lists available spaces
Client.list_spaces(self, string=False)
# Sets active space
Client.set_space(self, space_name)
# Updates and stores available files
Client.refresh_files(self, space_name=None)
# Lists only the available directories
Client.list_dirs(self, space_name=None, string=False, dir='')
# Lists only the available files
Client.list_files(self, space_name=None, string=False, dir='')
# Lists all files and directories
Client.list_all(self, space_name=None, string=False, dir='')
# Downloads specified file
Client.download_file(self, file_name, destination="downloads/", space_name=None)
# Uploads specified file
Client.upload_file(self, file, destination="", rename=None, space_name=None )
# Starts verbose shell
Client.shell(self)
CHANGELOG
0.1.5
- Fixed manifest
0.1.2
- Add region name field to env.yaml
- Add default space field to env.yaml
- Renamed import module to spaces for simplicity
0.1.1
- Documentation
0.1.0
- Initial release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for digital-ocean-spaces-0.1.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09b9a9d6a6af883d67c8e9813dcc8e91f2f7a22a401955fde8fc3bc72ecf2918 |
|
MD5 | 8a573a6feb99e61f67560a3006fab680 |
|
BLAKE2b-256 | 4440d80f9642d17e658a37ef64c10492b573c1d70b3dc3d0597f4dd02d9b9264 |