Update repo to semi-working state.

Author: toddbirchard

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+select = E9,F63,F7,F82
+exclude = .git,.github,__pycache__,.pytest_cache,.venv,logs,creds
+max-line-length = 120

.gitignore

@@ -106,10 +106,11 @@ venv.bak/
 # DS Store
 .DS_Store
 
+# Creds
 HackersAndSlackers-d2a47db89384.json
 HackersAndSlackers-d2a47db89384.json
 HackersAndSlackers-4893023543f3.json
 HackersAndSlackers-59ed81beb2ea.json
 HackersAndSlackers-aec129ee8154.json
-.env
-.DS_Store
+gcloud.json
+

Makefile

@@ -0,0 +1,93 @@
+PROJECT_NAME := $(shell basename $CURDIR)
+VIRTUAL_ENV := $(CURDIR)/.venv
+LOCAL_PYTHON := $(VIRTUAL_ENV)/bin/python3
+
+define HELP
+Manage $(PROJECT_NAME). Usage:
+
+make run        - Run $(PROJECT_NAME).
+make install    - Create virtual env, install dependencies, and run project.
+make deploy     - Install and run script by running `make install` and `make run` in succession.
+make update     - Update pip dependencies via Poetry and export output to requirements.txt.
+make format     - Format code with Pythons `Black` library.
+make lint       - Check code formatting with `flake8`.
+make clean      - Remove cached files and lock files.
+
+endef
+export HELP
+
+
+.PHONY: run install deploy update format lint clean help
+
+all help:
+	@echo "$$HELP"
+
+
+env: $(VIRTUAL_ENV)
+
+
+$(VIRTUAL_ENV):
+	if [ ! -d $(VIRTUAL_ENV) ]; then \
+		echo "Creating Python virtual env in \`${VIRTUAL_ENV}\`"; \
+		python3 -m venv $(VIRTUAL_ENV); \
+	fi
+
+
+.PHONY: run
+run: env
+	$(LOCAL_PYTHON) -m main:init_script
+
+
+.PHONY: install
+install: env
+	$(LOCAL_PYTHON) -m pip install --upgrade pip setuptools wheel && \
+	$(LOCAL_PYTHON) -m pip install -r requirements.txt && \
+	echo Installed dependencies in \`${VIRTUAL_ENV}\`;
+
+
+.PHONY: deploy
+deploy:
+	make install && \
+	make run
+
+
+.PHONY: update
+update: env
+	$(LOCAL_PYTHON) -m pip install --upgrade pip setuptools wheel && \
+	poetry update && \
+	poetry export -f requirements.txt --output requirements.txt --without-hashes && \
+	echo Installed dependencies in \`${VIRTUAL_ENV}\`;
+
+
+.PHONY: format
+format: env
+	isort --multi-line=3 . && \
+	black .
+
+
+.PHONY: lint
+lint:
+	flake8 . --count \
+			--select=E9,F63,F7,F82 \
+			--exclude .git,.github,__pycache__,.pytest_cache,.venv,logs,creds,.venv,docs,logs \
+			--show-source \
+			--statistics
+
+
+.PHONY: clean
+clean:
+	find . -name '.coverage' -delete && \
+	find . -name '*.pyc' -delete \
+	find . -name '__pycache__' -delete \
+	find . -name 'poetry.lock' -delete \
+	find . -name '*.log' -delete \
+	find . -name '.DS_Store' -delete \
+	find . -wholename '**/*.pyc' -delete && \
+	find . -wholename '**/*.html' -delete && \
+	find . -type d -wholename '__pycache__' -exec rm -rf {} + && \
+	find . -type d -wholename '.venv' -exec rm -rf {} + && \
+	find . -type d -wholename '.pytest_cache' -exec rm -rf {} + && \
+	find . -type d -wholename '**/.pytest_cache' -exec rm -rf {} + && \
+	find . -type d -wholename '**/*.log' -exec rm -rf {} + && \
+	find . -type d -wholename './.reports/*' -exec rm -rf {} + && \
+	find . -type d -wholename '**/.webassets-cache' -exec rm -rf {};

Pipfile

@@ -1,36 +1,32 @@
 # Google Cloud Storage Python SDK Tutorial
 
-![Python](https://img.shields.io/badge/Python-v3.7-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
-![Google Cloud Storage](https://img.shields.io/badge/Google--Cloud--Storage-v1.16.1-blue.svg?logo=Google&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
+![Python](https://img.shields.io/badge/Python-v3.10-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
+![Google Cloud Storage](https://img.shields.io/badge/Google--Cloud--Storage-v2.18.0-blue.svg?logo=Google&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
 ![GitHub Last Commit](https://img.shields.io/github/last-commit/google/skia.svg?style=flat-square&colorA=4c566a&colorB=a3be8c)
 [![GitHub Issues](https://img.shields.io/github/issues/toddbirchard/tableau-extraction.svg?style=flat-square&colorA=4c566a&colorB=ebcb8b)](https://github.com/hackersandslackers/googlecloud-storage-tutorial/issues)
 [![GitHub Stars](https://img.shields.io/github/stars/toddbirchard/tableau-extraction.svg?style=flat-square&colorB=ebcb8b&colorA=4c566a)](https://github.com/hackersandslackers/googlecloud-storage-tutorial/stargazers)
 [![GitHub Forks](https://img.shields.io/github/forks/toddbirchard/tableau-extraction.svg?style=flat-square&colorA=4c566a&colorB=ebcb8b)](https://github.com/hackersandslackers/googlecloud-storage-tutorial/network)
 
 ![Google Cloud Storage Python SDK Tutorial](https://storage.googleapis.com/hackersandslackers-cdn/2019/06/[email protected])
 
-Source for the accompanying tutorial: https://hackersandslackers.com/manage-files-in-google-cloud-storage-with-python/
+Source for the accompanying tutorial here: [https://hackersandslackers.com/google-cloud-storage-with-python/](https://hackersandslackers.com/google-cloud-storage-with-python/)
 
 ## Getting Started
 
-Installation is recommended with Pipenv:
+Installation is recommended via Makefile
 
 ```shell
 $ git clone https://github.com/hackersandslackers/googlecloud-storage-tutorial.git
 $ cd googlecloud-storage-tutorial
-$ pipenv shell
-$ pipenv update
-$ python3 main.py
+$ make install
 ```
 
-Alternatively, try installing via `setup.py`:
+### Usage
 
 ```shell
-$ git clone https://github.com/hackersandslackers/googlecloud-storage-tutorial.git
-$ cd googlecloud-storage-tutorial
-$ python3 setup.py install
-$ python3 main.py
+$ make run
 ```
+
 -----
 
 **Hackers and Slackers** tutorials are free of charge. If you found this tutorial helpful, a [small donation](https://www.buymeacoffee.com/hackersslackers) would be greatly appreciated to keep us in business. All proceeds go towards coffee, and all coffee goes towards more content.

Pipfile.lock

@@ -1,11 +1,10 @@
 """Google Cloud Storage Configuration."""
 from os import environ
 
-
 # Google Cloud Storage
-bucketURL = environ.get('GCP_BUCKET_URL')
-bucketName = environ.get('GCP_BUCKET_NAME')
-bucketFolder = environ.get('GCP_BUCKET_FOLDER_NAME')
+bucket_url = environ.get("GCP_BUCKET_URL")
+bucket_name = environ.get("GCP_BUCKET_NAME")
+bucket_dir = environ.get("GCP_BUCKET_FOLDER_NAME")
 
 # Data
-localFolder = environ.get('LOCAL_FOLDER')
+local_dir = environ.get("LOCAL_FOLDER")

README.md

@@ -0,0 +1,17 @@
+"""Initialize script demonstration"""
+from config import bucket_dir, bucket_name, local_dir
+from googlecloud_storage_tutorial.storage import (
+    delete_file,
+    download_random_file,
+    list_files,
+    rename_file,
+    upload_files,
+)
+
+
+def init_script():
+    print(upload_files(bucket_name))
+    print(list_files(bucket_name))
+    print(download_random_file(bucket_name, bucket_dir, local_dir))
+    print(rename_file(bucket_name, bucket_dir, "test.csv", "sample_test.csv"))
+    print(delete_file(bucket_name, bucket_dir, "sample_text.txt"))

config.py

@@ -0,0 +1,93 @@
+"""Programmatically interact with a Google Cloud Storage bucket."""
+from os import listdir
+from os.path import isfile, join
+from random import randint
+from typing import List, Optional
+
+from google.cloud import storage
+
+from config import bucket_dir, bucket_name, local_dir
+
+storage_client = storage.Client()
+bucket = storage_client.get_bucket(bucket_name)
+
+
+def upload_files(bucket_name: str, bucket_dir: str, local_dir: str) -> str:
+    """
+    Upload files to GCP bucket.
+
+    :param str bucket_name: Human-readable GCP bucket name.
+    :param str bucket_dir: Bucket directory in which object exists.
+    :param str local_dir: Local file path to upload/download files.
+
+    :returns: str
+    """
+    files = [f for f in listdir(local_dir) if isfile(join(local_dir, f))]
+    for file in files:
+        local_file = local_dir + file
+        blob = bucket.blob(bucket_dir + file)
+        blob.upload_from_filename(local_file)
+    return f"Uploaded {files.join(', ')} to '{bucket_name}' bucket."
+
+
+def list_files(bucket_dir: str) -> List[Optional[str]]:
+    """
+    List all objects with file extension in a GCP bucket.
+
+    :param str bucket_name: Human-readable GCP bucket name.
+    :param str bucket_dir: Bucket directory in which object exists.
+
+    :returns: List[Optional[str]]
+    """
+    files = bucket.list_blobs(prefix=bucket_dir)
+    file_list = [file.name for file in files if "." in file.name]
+    return file_list
+
+
+def download_random_file(bucket_name: str, local_dir: str) -> str:
+    """
+    Download random file from GCP bucket.
+
+    :param str bucket_name: Human-readable GCP bucket name.
+    :param str bucket_dir: Bucket directory in which object exists.
+    :param str local_dir: Local file path to upload/download files.
+
+    :returns: str
+    """
+    fileList = list_files(bucket_name)
+    rand = randint(0, len(fileList) - 1)
+    blob = bucket.blob(fileList[rand])
+    file_name = blob.name.split("/")[-1]
+    blob.download_to_filename(local_dir + file_name)
+    return f"{file_name} downloaded from bucket."
+
+
+def delete_file(bucket_name: str, bucket_dir: str) -> str:
+    """
+    Delete file from GCP bucket.
+
+    :param str bucket_name: Human-readable GCP bucket name.
+    :param str bucket_dir: Bucket directory in which object exists.
+
+    :returns: str
+    """
+    blob = bucket.blob(bucket_dir + file_name)
+    file_name = blob.name.split("/")[-1]
+    bucket.delete_blob(bucket_name + file_name)
+    return f"{file_name} deleted from bucket: {bucket_name}."
+
+
+def rename_file(bucket_dir: str, new_filename: str) -> str:
+    """
+    Rename a file in GCP bucket.
+
+    :param str bucket_name: Human-readable GCP bucket name.
+    :param str bucket_dir: Bucket directory from which to extract object.
+    :param str new_filename: New file name for Blob object.
+
+    :returns: str
+    """
+    blob = bucket.blob(bucket_dir + file_name)
+    file_name = blob.name.split("/")[-1]
+    bucket.rename_blob(blob, new_name=new_filename)
+    return f"{file_name} renamed to {new_filename}."

googlecloud_storage_tutorial/__init__.py

@@ -1,64 +1,4 @@
-"""Programatically interact with a Google Cloud Storage bucket."""
-from os import listdir
-from os.path import isfile, join
-from random import randint
-from google.cloud import storage
-from config import bucketName, localFolder, bucketFolder
+from googlecloud_storage_tutorial import init_script
 
-storage_client = storage.Client()
-bucket = storage_client.get_bucket(bucketName)
-
-
-def upload_files(bucketName):
-    """Upload files to GCP bucket."""
-    files = [f for f in listdir(localFolder) if isfile(join(localFolder, f))]
-    for file in files:
-        localFile = localFolder + file
-        blob = bucket.blob(bucketFolder + file)
-        blob.upload_from_filename(localFile)
-    return f'Uploaded {files} to "{bucketName}" bucket.'
-
-
-def list_files(bucketName):
-    """List all files in GCP bucket."""
-    files = bucket.list_blobs(prefix=bucketFolder)
-    fileList = [file.name for file in files if '.' in file.name]
-    return fileList
-
-
-def download_random_file(bucketName, bucketFolder, localFolder):
-    """Download random file from GCP bucket."""
-    fileList = list_files(bucketName)
-    rand = randint(0, len(fileList) - 1)
-    blob = bucket.blob(fileList[rand])
-    fileName = blob.name.split('/')[-1]
-    blob.download_to_filename(localFolder + fileName)
-    return f'{fileName} downloaded from bucket.'
-
-
-def delete_file(bucketName, bucketFolder, fileName):
-    """Delete file from GCP bucket."""
-    bucket.delete_blob(bucketFolder + fileName)
-    return f'{fileName} deleted from bucket.'
-
-
-def rename_file(bucketName, bucketFolder, fileName, newFileName):
-    """Rename file in GCP bucket."""
-    blob = bucket.blob(bucketFolder + fileName)
-    bucket.rename_blob(blob,
-                       new_name=newFileName)
-    return f'{fileName} renamed to {newFileName}.'
-
-
-print(upload_files(bucketName))
-print(list_files(bucketName))
-print(download_random_file(bucketName,
-                           bucketFolder,
-                           localFolder))
-print(rename_file(bucketName,
-                  bucketFolder,
-                  'test.csv',
-                  'sample_test.csv'))
-print(delete_file(bucketName,
-                  bucketFolder,
-                  'sample_text.txt'))
+if __name__ == "__main__":
+    init_script()