+
+
## Usage
-### Creating or Updating files on github
+### Upload files to github
```shell script
-gh-deploy update --org [org] --token [PAT_TOKEN] --dest [LOCATION TO UPLOAD FILE] --source [SOURCE FILE LOCATION]
+gh-deploy upload --org [org] --token [PAT_TOKEN] --dest [LOCATION TO UPLOAD FILE] --source [SOURCE FILE LOCATION]
```
Example:
```shell script
-gh-deploy update --org tj-actions --token [PAT_TOKEN] --dest '.github/workflows/auto-approve.yml' --source auto-approve.yml
+gh-deploy upload --org tj-actions --token [PAT_TOKEN] --dest '.github/workflows/auto-approve.yml' --source auto-approve.yml
```
> NOTE: `auto-approve.yml` is located on your local system.
diff --git a/github_deploy/__init__.py b/github_deploy/__init__.py
index 0260537..8db66d3 100644
--- a/github_deploy/__init__.py
+++ b/github_deploy/__init__.py
@@ -1 +1 @@
-__path__ = __import__('pkgutil').extend_path(__path__, __name__)
\ No newline at end of file
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)
diff --git a/github_deploy/commands/__init__.py b/github_deploy/commands/__init__.py
index 0260537..8db66d3 100644
--- a/github_deploy/commands/__init__.py
+++ b/github_deploy/commands/__init__.py
@@ -1 +1 @@
-__path__ = __import__('pkgutil').extend_path(__path__, __name__)
\ No newline at end of file
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)
diff --git a/github_deploy/commands/_constants.py b/github_deploy/commands/_constants.py
index 1249c71..174b0a3 100644
--- a/github_deploy/commands/_constants.py
+++ b/github_deploy/commands/_constants.py
@@ -1,2 +1,2 @@
-REPOS_URL = "https://api.github.com/search/repositories?q=org:{org}"
-BASE_URL = "https://api.github.com/repos/{repo}/contents/{path}"
+REPOS_URL = "https://api.github.com/users/{org}/repos?per_page=100"
+FILE_CONTENTS_URL = "https://api.github.com/repos/{repo}/contents/{path}"
diff --git a/github_deploy/commands/_http_utils.py b/github_deploy/commands/_http_utils.py
new file mode 100644
index 0000000..539b9ec
--- /dev/null
+++ b/github_deploy/commands/_http_utils.py
@@ -0,0 +1,50 @@
+import ssl
+
+import certifi
+
+
+async def get(*, session, url, headers=None, skip_missing=False):
+ ssl_context = ssl.create_default_context(cafile=certifi.where())
+
+ async with session.get(
+ url,
+ headers=headers,
+ timeout=70,
+ ssl_context=ssl_context,
+ raise_for_status=not skip_missing,
+ ) as response:
+ if skip_missing and response.status == 404:
+ return {}
+
+ value = await response.json()
+ return value
+
+
+async def put(*, session, url, data, headers=None):
+ ssl_context = ssl.create_default_context(cafile=certifi.where())
+
+ async with session.put(
+ url,
+ json=data,
+ headers=headers,
+ timeout=70,
+ ssl_context=ssl_context,
+ raise_for_status=True,
+ ) as response:
+ value = await response.json()
+ return value
+
+
+async def delete(*, session, url, data, headers=None):
+ ssl_context = ssl.create_default_context(cafile=certifi.where())
+
+ async with session.delete(
+ url,
+ json=data,
+ headers=headers,
+ timeout=70,
+ ssl_context=ssl_context,
+ raise_for_status=True,
+ ) as response:
+ value = await response.json()
+ return value
diff --git a/github_deploy/commands/_repo_utils.py b/github_deploy/commands/_repo_utils.py
new file mode 100644
index 0000000..a7aa389
--- /dev/null
+++ b/github_deploy/commands/_repo_utils.py
@@ -0,0 +1,135 @@
+import base64
+import os
+
+import asyncclick as click
+from aiofiles import os as aiofiles_os, open as aiofiles_open
+
+from github_deploy.commands._constants import REPOS_URL, FILE_CONTENTS_URL
+from github_deploy.commands._http_utils import get, delete, put
+from github_deploy.commands._utils import get_headers
+
+
+async def list_repos(*, session, org, token):
+ url = REPOS_URL.format(org=org)
+ click.echo(f"Retrieving repos at {url}")
+ response = await get(session=session, url=url, headers=get_headers(token=token))
+ return response
+
+
+async def delete_content(
+ *,
+ session,
+ repo,
+ dest,
+ token,
+ semaphore,
+ exists,
+ current_sha,
+):
+ data = {"message": f"Deleted {dest}"}
+ if exists:
+ data["sha"] = current_sha
+
+ url = FILE_CONTENTS_URL.format(repo=repo, path=dest)
+
+ async with semaphore:
+ response = await delete(
+ session=session, url=url, data=data, headers=get_headers(token=token)
+ )
+
+ return response
+
+
+async def check_exists(*, session, repo, dest, token, semaphore, skip_missing):
+ url = FILE_CONTENTS_URL.format(repo=repo, path=dest)
+
+ async with semaphore:
+ response = await get(
+ session=session,
+ url=url,
+ headers=get_headers(token=token),
+ skip_missing=skip_missing,
+ )
+
+ return response
+
+
+async def upload_content(
+ *,
+ session,
+ repo,
+ source,
+ dest,
+ token,
+ semaphore,
+ exists,
+ only_update,
+ current_sha,
+ current_content
+):
+ async with semaphore:
+ async with aiofiles_open(source, mode="rb") as f:
+ output = await f.read()
+ base64_content = base64.b64encode(output).decode("ascii")
+
+ if current_content == base64_content:
+ click.echo(
+ click.style(
+ f"Skipped uploading {source} to {repo}/{dest}: No changes detected.",
+ fg="yellow",
+ bold=True,
+ )
+ )
+ return
+ else:
+ if exists:
+ click.echo(
+ click.style(
+ "Storing backup of existing file at {repo}/{path}...".format(
+ repo=repo, path=dest
+ ),
+ fg="cyan",
+ ),
+ )
+
+ dirname, filename = os.path.split(f"{repo}/{dest}")
+
+ await aiofiles_os.makedirs(dirname, exist_ok=True)
+
+ async with aiofiles_open(f"{dirname}/{filename}", mode="wb") as f:
+ await f.write(base64.b64decode(current_content))
+ elif only_update:
+ click.echo(
+ click.style(
+ f"Updates only: Skipped uploading {source} to {repo}/{dest}. File does not exist.",
+ fg="yellow",
+ bold=True,
+ )
+ )
+ return
+
+ data = {
+ "message": f"Updated {dest}"
+ if exists
+ else f"Added {dest}",
+ "content": base64_content,
+ }
+ if exists:
+ data["sha"] = current_sha
+
+ url = FILE_CONTENTS_URL.format(repo=repo, path=dest)
+
+ click.echo(
+ click.style(
+ f"Uploading {source} to {repo}/{dest}...",
+ fg="green",
+ bold=True,
+ )
+ )
+
+ async with semaphore:
+ response = await put(
+ session=session, url=url, data=data, headers=get_headers(token=token)
+ )
+
+ return response
diff --git a/github_deploy/commands/_utils.py b/github_deploy/commands/_utils.py
index 67cdb6b..afc4b79 100644
--- a/github_deploy/commands/_utils.py
+++ b/github_deploy/commands/_utils.py
@@ -1,6 +1,17 @@
def get_repo(*, org, project):
- return "{org}/{project}".format(project=project, org=org)
+ return f"{org}/{project}"
def can_upload(*, repo, include_private):
- return True if include_private and repo['private'] == True else not repo['private']
+ return (
+ True
+ if include_private and repo["private"] is True
+ else not repo["private"]
+ )
+
+
+def get_headers(*, token):
+ return {
+ "Authorization": f"Bearer {token}",
+ "Accept": "application/vnd.github+json",
+ }
diff --git a/github_deploy/commands/delete.py b/github_deploy/commands/delete.py
index f85c9c0..f34a8ef 100644
--- a/github_deploy/commands/delete.py
+++ b/github_deploy/commands/delete.py
@@ -1,88 +1,13 @@
import asyncio
-import ssl
import aiohttp
import asyncclick as click
-import certifi
-from github_deploy.commands._constants import BASE_URL, REPOS_URL
+from github_deploy.commands._repo_utils import list_repos, delete_content, check_exists
from github_deploy.commands._utils import get_repo
-async def get(*, session, url, headers=None, skip_missing=False):
- ssl_context = ssl.create_default_context(cafile=certifi.where())
-
- async with session.get(
- url,
- headers=headers,
- timeout=70,
- ssl_context=ssl_context,
- raise_for_status=not skip_missing,
- ) as response:
- if skip_missing and response.status == 404:
- return {}
-
- value = await response.json()
- return value
-
-
-async def delete(*, session, url, data, headers=None):
- ssl_context = ssl.create_default_context(cafile=certifi.where())
-
- async with session.delete(
- url,
- json=data,
- headers=headers,
- timeout=70,
- ssl_context=ssl_context,
- raise_for_status=True,
- ) as response:
- value = await response.json()
- return value
-
-
-async def delete_content(
- *,
- session,
- repo,
- dest,
- token,
- semaphore,
- exists,
- current_sha,
-):
- headers = {
- "Authorization": "token {token}".format(token=token),
- "Accept": "application/vnd.github.v3+json",
- }
-
- data = {"message": "Deleted {}".format(dest)}
- if exists:
- data["sha"] = current_sha
-
- url = BASE_URL.format(repo=repo, path=dest)
-
- async with semaphore:
- response = await delete(session=session, url=url, data=data, headers=headers)
-
- return response
-
-
-async def check_exists(*, session, repo, dest, token, semaphore, skip_missing):
- headers = {"Authorization": "token {token}".format(token=token)}
- url = BASE_URL.format(repo=repo, path=dest)
-
- async with semaphore:
- response = await get(
- session=session, url=url, headers=headers, skip_missing=skip_missing
- )
-
- return response
-
-
-async def handle_file_delete(
- *, repo, dest, token, semaphore, session
-):
+async def handle_file_delete(*, repo, dest, token, semaphore, session):
check_exists_response = await check_exists(
session=session,
repo=repo,
@@ -114,7 +39,7 @@ async def handle_file_delete(
exists=exists,
current_sha=current_sha,
)
-
+
if delete_response:
return click.style(
"Successfully deleted contents at {repo}/{dest}".format(
@@ -124,25 +49,14 @@ async def handle_file_delete(
fg="green",
bold=True,
)
-
+
return click.style(
- "No content found at {repo}/{dest}".format(repo=repo, dest=dest),
+ f"No content found at {repo}/{dest}",
fg="blue",
bold=True,
)
-async def list_repos(*, session, org, token):
- headers = {
- "Authorization": "token {token}".format(token=token),
- "Accept": "application/vnd.github.v3+json",
- }
- url = REPOS_URL.format(org=org)
- click.echo("Retrieving repos at {}".format(url))
- response = await get(session=session, url=url, headers=headers)
- return response
-
-
@click.command()
@click.option(
"--org",
@@ -154,7 +68,7 @@ async def list_repos(*, session, org, token):
prompt=click.style("Enter your personal access token", bold=True),
help="Personal Access token with read and write access to org.",
hide_input=True,
- envvar='TOKEN',
+ envvar="TOKEN",
)
@click.option(
"--dest",
@@ -173,16 +87,23 @@ async def main(org, token, dest):
response = await list_repos(org=org, token=token, session=session)
repos = [
get_repo(org=org, project=v["name"])
- for v in response["items"]
+ for v in response
if not v["archived"]
]
click.echo(
click.style(
- "Found '{}' repositories non archived repositories".format(len(repos)),
+ "Found '{}' repositories non archived repositories".format(
+ len(repos)
+ ),
fg="green",
)
)
- click.echo(click.style('Deleting "{path}" for all repositories:'.format(path=dest), fg="blue"))
+ click.echo(
+ click.style(
+ f'Deleting "{dest}" for all repositories:',
+ fg="blue",
+ )
+ )
click.echo("\n".join(repos))
c = click.prompt(click.style("Continue? [YN] ", fg="blue"))
diff --git a/github_deploy/commands/upload.py b/github_deploy/commands/upload.py
index 47d453c..52813b0 100644
--- a/github_deploy/commands/upload.py
+++ b/github_deploy/commands/upload.py
@@ -1,103 +1,14 @@
import asyncio
-import base64
-import ssl
-import aiofiles
import aiohttp
import asyncclick as click
-import certifi
-from github_deploy.commands._constants import BASE_URL, REPOS_URL
+from github_deploy.commands._repo_utils import list_repos, check_exists, upload_content
from github_deploy.commands._utils import get_repo, can_upload
-async def get(*, session, url, headers=None, skip_missing=False):
- ssl_context = ssl.create_default_context(cafile=certifi.where())
-
- async with session.get(
- url,
- headers=headers,
- timeout=70,
- ssl_context=ssl_context,
- raise_for_status=not skip_missing,
- ) as response:
- if skip_missing and response.status == 404:
- return {}
-
- value = await response.json()
- return value
-
-
-async def put(*, session, url, data, headers=None):
- ssl_context = ssl.create_default_context(cafile=certifi.where())
-
- async with session.put(
- url,
- json=data,
- headers=headers,
- timeout=70,
- ssl_context=ssl_context,
- raise_for_status=True,
- ) as response:
- value = await response.json()
- return value
-
-
-async def upload_content(
- *,
- session,
- repo,
- source,
- dest,
- token,
- semaphore,
- exists,
- current_sha,
- current_content
-):
- headers = {
- "Authorization": "token {token}".format(token=token),
- "Accept": "application/vnd.github.v3+json",
- }
-
- async with semaphore:
- async with aiofiles.open(source, mode="rb") as f:
- output = await f.read()
- base64_content = base64.b64encode(output).decode("ascii")
-
- if current_content == base64_content:
- click.echo("Skipping: Contents are the same.")
- return
-
- data = {
- "message": "Updated {}".format(dest) if exists else "Added {}".format(dest),
- "content": base64_content,
- }
- if exists:
- data["sha"] = current_sha
-
- url = BASE_URL.format(repo=repo, path=dest)
-
- async with semaphore:
- response = await put(session=session, url=url, data=data, headers=headers)
-
- return response
-
-
-async def check_exists(*, session, repo, dest, token, semaphore, skip_missing):
- headers = {"Authorization": "token {token}".format(token=token)}
- url = BASE_URL.format(repo=repo, path=dest)
-
- async with semaphore:
- response = await get(
- session=session, url=url, headers=headers, skip_missing=skip_missing
- )
-
- return response
-
-
async def handle_file_upload(
- *, repo, source, dest, overwrite, token, semaphore, session
+ *, repo, source, dest, overwrite, only_update, token, semaphore, session
):
check_exists_response = await check_exists(
session=session,
@@ -112,19 +23,18 @@ async def handle_file_upload(
current_content = check_exists_response.get("content")
exists = current_sha is not None
- if exists and not overwrite:
- return click.style(
- "Skipped uploading {source} to {repo}/{path}: Found an existing copy.".format(
- source=source,
- repo=repo,
- path=dest,
- ),
- fg="blue",
- bold=True
- )
-
- else:
- if exists:
+ if exists:
+ if not overwrite:
+ click.style(
+ "Skipped uploading {source} to {repo}/{path}: Found an existing copy.".format(
+ source=source,
+ repo=repo,
+ path=dest,
+ ),
+ fg="blue",
+ bold=True,
+ )
+ else:
click.echo(
click.style(
"Found an existing copy at {repo}/{path} overwriting it's contents...".format(
@@ -134,53 +44,43 @@ async def handle_file_upload(
),
)
- upload_response = await upload_content(
- session=session,
- repo=repo,
- source=source,
- dest=dest,
- token=token,
- semaphore=semaphore,
- exists=exists,
- current_sha=current_sha,
- current_content=current_content,
- )
-
- if upload_response:
- return click.style(
- "Successfully uploaded '{source}' to {repo}/{dest}".format(
- source=upload_response["content"]["name"],
- repo=repo,
- dest=upload_response["content"]["path"],
- ),
- fg="green",
- bold=True
- )
-
+ upload_response = await upload_content(
+ session=session,
+ repo=repo,
+ source=source,
+ dest=dest,
+ token=token,
+ semaphore=semaphore,
+ exists=exists,
+ only_update=only_update,
+ current_sha=current_sha,
+ current_content=current_content,
+ )
-async def list_repos(*, session, org, token):
- headers = {
- "Authorization": "token {token}".format(token=token),
- "Accept": "application/vnd.github.v3+json",
- }
- url = REPOS_URL.format(org=org)
- click.echo("Retrieving repos at {}".format(url))
- response = await get(session=session, url=url, headers=headers)
- return response
+ if upload_response:
+ return click.style(
+ "Successfully uploaded '{source}' to {repo}/{dest}".format(
+ source=upload_response["content"]["name"],
+ repo=repo,
+ dest=upload_response["content"]["path"],
+ ),
+ fg="green",
+ bold=True,
+ )
@click.command()
-@click.option(
- "--org",
- prompt=click.style("Enter your github user/organization", bold=True),
- help="The github organization.",
-)
@click.option(
"--token",
prompt=click.style("Enter your personal access token", bold=True),
help="Personal Access token with read and write access to org.",
hide_input=True,
- envvar='TOKEN',
+ envvar="TOKEN",
+)
+@click.option(
+ "--org",
+ prompt=click.style("Enter your github user/organization", bold=True),
+ help="The github organization.",
)
@click.option(
"--source",
@@ -195,17 +95,33 @@ async def list_repos(*, session, org, token):
)
@click.option(
"--overwrite/--no-overwrite",
- prompt=click.style("Should we overwrite existing contents at this path", fg="blue"),
+ prompt=click.style(
+ "Should we overwrite existing contents at this path", fg="blue"
+ ),
+ is_flag=True,
+ show_default=True,
help="Overwrite existing files.",
default=False,
)
+@click.option(
+ "--only-update/--no-only-update",
+ prompt=click.style(
+ "Should we only update existing files at this path", fg="blue"
+ ),
+ is_flag=True,
+ show_default=True,
+ help="Only update existing files.",
+ default=False,
+)
@click.option(
"--private/--no-private",
prompt=click.style("Should we Include private repositories", bold=True),
+ is_flag=True,
+ show_default=True,
help="Upload files to private repositories.",
default=True,
)
-async def main(org, token, source, dest, overwrite, private):
+async def main(org, token, source, dest, overwrite, only_update, private):
"""Upload a file to all repositories owned by an organization/user."""
# create instance of Semaphore: max concurrent requests.
semaphore = asyncio.Semaphore(1000)
@@ -216,13 +132,16 @@ async def main(org, token, source, dest, overwrite, private):
response = await list_repos(org=org, token=token, session=session)
repos = [
get_repo(org=org, project=r["name"])
- for r in response["items"]
- if not r["archived"] and can_upload(repo=r, include_private=private)
+ for r in response
+ if not r["archived"]
+ and can_upload(repo=r, include_private=private)
]
- repo_type = 'public and private' if private else 'public'
+ repo_type = "public and private" if private else "public"
click.echo(
click.style(
- "Found '{}' repositories non archived {} repositories:".format(len(repos), repo_type),
+ "Found '{}' repositories non archived {} repositories:".format(
+ len(repos), repo_type
+ ),
fg="green",
)
)
@@ -237,14 +156,21 @@ async def main(org, token, source, dest, overwrite, private):
fg="bright_red",
)
)
- deploy_msg = (
- 'Deploying "{source}" to "{path}" for all repositories'.format(source=source, path=dest)
- if overwrite
- else 'Deploying "{source}" to repositories that don\'t already have contents at "{path}"'.format(
- source=source,
- path=dest
+
+ if overwrite:
+ if only_update:
+ deploy_msg = "Updating '{source}' for existing files located at '{dest}'".format(
+ source=source, dest=dest
+ )
+ else:
+ deploy_msg = "Overwriting '{dest}' with '{source}'".format(
+ source=source, dest=dest
+ )
+ else:
+ deploy_msg = "Deploying '{source}' to repositories that don\'t already have contents at '{path}'".format(
+ source=source, path=dest
)
- )
+
click.echo(click.style(deploy_msg, fg="blue"))
c = click.prompt(click.style("Continue? [YN] ", fg="blue"))
@@ -265,6 +191,7 @@ async def main(org, token, source, dest, overwrite, private):
dest=dest,
token=token,
overwrite=overwrite,
+ only_update=only_update,
session=session,
semaphore=semaphore,
)
diff --git a/github_deploy/main.py b/github_deploy/main.py
index bec9463..c93ad51 100644
--- a/github_deploy/main.py
+++ b/github_deploy/main.py
@@ -1,31 +1,42 @@
-import asyncclick as click
import os
-plugin_folder = os.path.join(os.path.dirname(__file__), 'commands')
+import asyncclick as click
+plugin_folder = os.path.join(os.path.dirname(__file__), "commands")
-class GithubDeploy(click.MultiCommand):
+class GithubDeploy(click.MultiCommand):
def list_commands(self, ctx):
rv = []
for filename in os.listdir(plugin_folder):
- if filename.endswith('.py') and not filename.startswith('__init__') and not filename.startswith('_'):
+ if (
+ filename.endswith(".py")
+ and not filename.startswith("__init__")
+ and not filename.startswith("_")
+ ):
rv.append(filename[:-3])
rv.sort()
return rv
def get_command(self, ctx, name):
ns = {}
- fn = os.path.join(plugin_folder, name + '.py')
- with open(fn) as f:
- code = compile(f.read(), fn, 'exec')
- eval(code, ns, ns)
- return ns['main']
+ fn = os.path.join(plugin_folder, name + ".py")
+
+ if os.path.exists(fn):
+ with open(fn) as f:
+ code = compile(f.read(), fn, "exec")
+ eval(code, ns, ns)
+ return ns["main"]
+
+ ctx.fail(f"Invalid Command \"{name}\"")
main = GithubDeploy(
- help='Deploy changes to multiple github repositories using a single command.',
+ help=(
+ "Deploy changes to multiple github repositories using "
+ "a single command."
+ ),
)
-if __name__ == '__main__':
+if __name__ == "__main__":
main()
diff --git a/setup.py b/setup.py
index c6a6cfe..29124f3 100644
--- a/setup.py
+++ b/setup.py
@@ -23,7 +23,7 @@
setup(
name="github-deploy",
- version="0.0.8",
+ version="1.2.0",
description="Deploy yaml files to a large number of repositories in seconds.",
long_description=LONG_DESCRIPTION,
long_description_content_type=LONG_DESCRIPTION_TYPE,
@@ -34,12 +34,18 @@
"gh-deploy=github_deploy.main:main",
],
},
- keywords=["yaml", "deploy", "poly repository", "github", "single configuration"],
+ keywords=[
+ "yaml",
+ "deploy",
+ "poly repository",
+ "github",
+ "single configuration",
+ ],
author="Tonye Jack",
author_email="jtonye@ymail.com",
license="MIT",
packages=find_packages(),
- python_requires='>=3.6',
+ python_requires=">=3.7",
extras_require=extras_require,
install_requires=[
"asyncclick",
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: