From 9a5131b076d1c91d61e390a9f30a6771b8ab935e Mon Sep 17 00:00:00 2001 From: dormant-user Date: Tue, 25 Jun 2024 12:10:25 -0500 Subject: [PATCH] Update docs and onboard `none-shall-pass` --- .github/workflows/markdown.yaml | 13 ++++ README.md | 5 +- docs/README.html | 25 ++++---- docs/README.md | 105 ++++++++------------------------ docs/_sources/README.md.txt | 105 ++++++++------------------------ docs/searchindex.js | 2 +- pre_commit.sh | 4 +- 7 files changed, 86 insertions(+), 173 deletions(-) create mode 100644 .github/workflows/markdown.yaml mode change 100644 => 100755 pre_commit.sh diff --git a/.github/workflows/markdown.yaml b/.github/workflows/markdown.yaml new file mode 100644 index 0000000..e736a32 --- /dev/null +++ b/.github/workflows/markdown.yaml @@ -0,0 +1,13 @@ +name: none-shall-pass + +on: + push: + branches: + - main + workflow_dispatch: + +jobs: + none-shall-pass: + runs-on: thevickypedia-lite + steps: + - uses: thevickypedia/none-shall-pass@v5 diff --git a/README.md b/README.md index edb5919..5b0c1c0 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Backup GitHub projects to AWS S3 [![pages][label-actions-pages]][gha_pages] [![pypi][label-actions-pypi]][gha_pypi] +[![markdown][label-actions-markdown]][gha_md_valid] [![Pypi][label-pypi]][pypi] [![Pypi-format][label-pypi-format]][pypi-files] @@ -89,9 +90,10 @@ pre-commit run --all-files © Vignesh Rao Licensed under the [MIT License][license] - + [//]: # (Labels) +[label-actions-markdown]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml/badge.svg [label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-git2s3-blue?style=for-the-badge&logo=Python [label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx [label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-orange @@ -108,6 +110,7 @@ Licensed under the [MIT License][license] [release-notes]: https://github.com/thevickypedia/git2s3/blob/master/release_notes.rst [gha_pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment [gha_pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml +[gha_md_valid]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings [pep8]: https://www.python.org/dev/peps/pep-0008/ [isort]: https://pycqa.github.io/isort/ diff --git a/docs/README.html b/docs/README.html index cf663e4..fe140a5 100644 --- a/docs/README.html +++ b/docs/README.html @@ -51,10 +51,11 @@

Git2S3Platform

Deployments

pages -pypi

-

Pypi -Pypi-format -Pypi-status

+pypi +markdown

+

Pypi +Pypi-format +Pypi-status

Kick off

Recommendations

@@ -80,7 +81,7 @@

Kick offGit2S3 --help for usage instructions.

+

Use git2s3 --help for usage instructions.

@@ -89,7 +90,7 @@

Coding StandardsPEP 8 and isort

-

Release Notes

+

Release Notes

Requirement

python -m pip install gitverse
@@ -114,19 +115,19 @@

Linting

Pypi Package

-

pypi-module

-

https://pypi.org/project/Git2S3/

+

pypi-module

+

https://pypi.org/project/git2s3/

Runbook

-

made-with-sphinx-doc

-

https://Git2S3-docs.vigneshrao.com/

+

made-with-sphinx-doc

+

https://thevickypedia.github.io/git2s3/

+

Licensed under the MIT License

+ diff --git a/docs/README.md b/docs/README.md index f9807e9..5b0c1c0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -11,6 +11,7 @@ Backup GitHub projects to AWS S3 [![pages][label-actions-pages]][gha_pages] [![pypi][label-actions-pypi]][gha_pypi] +[![markdown][label-actions-markdown]][gha_md_valid] [![Pypi][label-pypi]][pypi] [![Pypi-format][label-pypi-format]][pypi-files] @@ -43,7 +44,7 @@ if __name__ == '__main__': git2s3 start ``` -> Use `Git2S3 --help` for usage instructions. +> Use `git2s3 --help` for usage instructions. ## Coding Standards Docstring format: [`Google`][google-docs]
@@ -75,14 +76,14 @@ pre-commit run --all-files ``` ## Pypi Package -[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)][pypi-repo] +[![pypi-module][label-pypi-package]][pypi-repo] -[https://pypi.org/project/Git2S3/][pypi] +[https://pypi.org/project/git2s3/][pypi] ## Runbook -[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)][sphinx] +[![made-with-sphinx-doc][label-sphinx-doc]][sphinx] -[https://Git2S3-docs.vigneshrao.com/][runbook] +[https://thevickypedia.github.io/git2s3/][runbook] ## License & copyright @@ -90,86 +91,32 @@ pre-commit run --all-files Licensed under the [MIT License][license] -[python]: https://python.org +[//]: # (Labels) + +[label-actions-markdown]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml/badge.svg +[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-git2s3-blue?style=for-the-badge&logo=Python +[label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx +[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-orange +[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg +[label-actions-pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment/badge.svg +[label-actions-pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml/badge.svg +[label-pypi]: https://img.shields.io/pypi/v/git2s3 +[label-pypi-format]: https://img.shields.io/pypi/format/git2s3 +[label-pypi-status]: https://img.shields.io/pypi/status/git2s3 + [3.10]: https://docs.python.org/3/whatsnew/3.10.html [3.11]: https://docs.python.org/3/whatsnew/3.11.html [virtual environment]: https://docs.python.org/3/tutorial/venv.html -[PyCharm]: https://www.jetbrains.com/pycharm/ -[VSCode]: https://code.visualstudio.com/download -[repo]: https://api.github.com/repos/thevickypedia/Git2S3 -[license]: https://github.com/thevickypedia/Git2S3/blob/master/LICENSE -[pypi]: https://pypi.org/project/Git2S3 -[pypi-files]: https://pypi.org/project/Git2S3/#files -[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/ -[wiki]: https://github.com/thevickypedia/Git2S3/wiki -[release-notes]: https://github.com/thevickypedia/Git2S3/blob/master/release_notes.rst +[release-notes]: https://github.com/thevickypedia/git2s3/blob/master/release_notes.rst [gha_pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment [gha_pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml -[gha_md_valid]: https://github.com/thevickypedia/Git2S3/actions/workflows/markdown.yml -[gha_cleanup]: https://github.com/thevickypedia/Git2S3/actions/workflows/cleanup.yml -[webpage]: https://vigneshrao.com/ -[webpage_contact]: https://vigneshrao.com/contact -[Anaconda]: https://docs.conda.io/projects/conda/en/latest/user-guide/install/ -[Miniconda]: https://docs.conda.io/en/latest/miniconda.html#windows-installers -[vcpp]: https://visualstudio.microsoft.com/visual-cpp-build-tools/ -[git-cli]: https://git-scm.com/download/win/ +[gha_md_valid]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings [pep8]: https://www.python.org/dev/peps/pep-0008/ [isort]: https://pycqa.github.io/isort/ [sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html -[runbook]: https://Git2S3-docs.vigneshrao.com/ - - - -[label-python]: https://img.shields.io/badge/Made%20with-Python-blue?style=for-the-badge&logo=Python -[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-orange -[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg - -[label-language-ct]: https://img.shields.io/github/languages/count/thevickypedia/Git2S3 -[label-code-coverage]: https://img.shields.io/github/languages/top/thevickypedia/Git2S3 - -[label-license]: https://img.shields.io/github/license/thevickypedia/Git2S3 - -[label-stars]: https://img.shields.io/github/stars/thevickypedia/Git2S3 -[label-forks]: https://img.shields.io/github/forks/thevickypedia/Git2S3 -[label-watchers]: https://img.shields.io/github/watchers/thevickypedia/Git2S3 - -[label-repo-size]: https://img.shields.io/github/repo-size/thevickypedia/Git2S3 -[label-code-size]: https://img.shields.io/github/languages/code-size/thevickypedia/Git2S3 -[label-code-line]: http://Git2S3.vigneshrao.com/line-count?badge=true -[label-file-count]: http://Git2S3.vigneshrao.com/file-count?badge=true - -[label-issues-closed]: https://img.shields.io/github/issues-closed-raw/thevickypedia/Git2S3 -[label-issues-raw]: https://img.shields.io/github/issues-raw/thevickypedia/Git2S3 -[label-pr-closed]: https://img.shields.io/github/issues-pr-closed-raw/thevickypedia/Git2S3 -[label-pr-raw]: https://img.shields.io/github/issues-pr-raw/thevickypedia/Git2S3 - -[label-file-count]: https://tokei.rs/b1/github/thevickypedia/Git2S3?category=files -[label-line-of-code]: https://tokei.rs/b1/github/thevickypedia/Git2S3?category=code - -[label-stats-Modules]: https://img.shields.io/github/search/thevickypedia/Git2S3/module -[label-stats-Python]: https://img.shields.io/github/search/thevickypedia/Git2S3/.py -[label-stats-Threads]: https://img.shields.io/github/search/thevickypedia/Git2S3/thread -[label-stats-Listener]: https://img.shields.io/github/search/thevickypedia/Git2S3/listener -[label-stats-Speaker]: https://img.shields.io/github/search/thevickypedia/Git2S3/speaker -[label-stats-Bash]: https://img.shields.io/github/search/thevickypedia/Git2S3/.sh -[label-stats-AppleScript]: https://img.shields.io/github/search/thevickypedia/Git2S3/.scpt -[label-stats-Make]: https://img.shields.io/github/search/thevickypedia/Git2S3/Makefile - -[label-actions-pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment/badge.svg -[label-actions-pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml/badge.svg - -[label-pypi]: https://img.shields.io/pypi/v/git2s3 -[label-pypi-format]: https://img.shields.io/pypi/format/Git2S3 -[label-pypi-status]: https://img.shields.io/pypi/status/Git2S3 - -[label-github-repo-created]: https://img.shields.io/date/1599432310 -[label-github-commit-activity]: https://img.shields.io/github/commit-activity/y/thevickypedia/Git2S3 -[label-github-last-commit]: https://img.shields.io/github/last-commit/thevickypedia/Git2S3 -[label-github-last-release]: https://img.shields.io/github/release-date/thevickypedia/Git2S3 - -[label-active-development]: https://img.shields.io/badge/Development%20Level-Actively%20Developed-success.svg -[label-actively-maintained]: https://img.shields.io/badge/Maintenance%20Level-Actively%20Maintained-success.svg -[label-maintainer]: https://img.shields.io/badge/Maintained%20By-Vignesh%20Rao-blue.svg - -[label-askme]: https://img.shields.io/badge/SELECT%20*%20FROM-questions-1abc9c.svg +[pypi]: https://pypi.org/project/git2s3 +[pypi-files]: https://pypi.org/project/git2s3/#files +[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/ +[license]: https://github.com/thevickypedia/git2s3/blob/master/LICENSE +[runbook]: https://thevickypedia.github.io/git2s3/ diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt index f9807e9..5b0c1c0 100644 --- a/docs/_sources/README.md.txt +++ b/docs/_sources/README.md.txt @@ -11,6 +11,7 @@ Backup GitHub projects to AWS S3 [![pages][label-actions-pages]][gha_pages] [![pypi][label-actions-pypi]][gha_pypi] +[![markdown][label-actions-markdown]][gha_md_valid] [![Pypi][label-pypi]][pypi] [![Pypi-format][label-pypi-format]][pypi-files] @@ -43,7 +44,7 @@ if __name__ == '__main__': git2s3 start ``` -> Use `Git2S3 --help` for usage instructions. +> Use `git2s3 --help` for usage instructions. ## Coding Standards Docstring format: [`Google`][google-docs]
@@ -75,14 +76,14 @@ pre-commit run --all-files ``` ## Pypi Package -[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)][pypi-repo] +[![pypi-module][label-pypi-package]][pypi-repo] -[https://pypi.org/project/Git2S3/][pypi] +[https://pypi.org/project/git2s3/][pypi] ## Runbook -[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)][sphinx] +[![made-with-sphinx-doc][label-sphinx-doc]][sphinx] -[https://Git2S3-docs.vigneshrao.com/][runbook] +[https://thevickypedia.github.io/git2s3/][runbook] ## License & copyright @@ -90,86 +91,32 @@ pre-commit run --all-files Licensed under the [MIT License][license] -[python]: https://python.org +[//]: # (Labels) + +[label-actions-markdown]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml/badge.svg +[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-git2s3-blue?style=for-the-badge&logo=Python +[label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx +[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-orange +[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg +[label-actions-pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment/badge.svg +[label-actions-pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml/badge.svg +[label-pypi]: https://img.shields.io/pypi/v/git2s3 +[label-pypi-format]: https://img.shields.io/pypi/format/git2s3 +[label-pypi-status]: https://img.shields.io/pypi/status/git2s3 + [3.10]: https://docs.python.org/3/whatsnew/3.10.html [3.11]: https://docs.python.org/3/whatsnew/3.11.html [virtual environment]: https://docs.python.org/3/tutorial/venv.html -[PyCharm]: https://www.jetbrains.com/pycharm/ -[VSCode]: https://code.visualstudio.com/download -[repo]: https://api.github.com/repos/thevickypedia/Git2S3 -[license]: https://github.com/thevickypedia/Git2S3/blob/master/LICENSE -[pypi]: https://pypi.org/project/Git2S3 -[pypi-files]: https://pypi.org/project/Git2S3/#files -[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/ -[wiki]: https://github.com/thevickypedia/Git2S3/wiki -[release-notes]: https://github.com/thevickypedia/Git2S3/blob/master/release_notes.rst +[release-notes]: https://github.com/thevickypedia/git2s3/blob/master/release_notes.rst [gha_pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment [gha_pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml -[gha_md_valid]: https://github.com/thevickypedia/Git2S3/actions/workflows/markdown.yml -[gha_cleanup]: https://github.com/thevickypedia/Git2S3/actions/workflows/cleanup.yml -[webpage]: https://vigneshrao.com/ -[webpage_contact]: https://vigneshrao.com/contact -[Anaconda]: https://docs.conda.io/projects/conda/en/latest/user-guide/install/ -[Miniconda]: https://docs.conda.io/en/latest/miniconda.html#windows-installers -[vcpp]: https://visualstudio.microsoft.com/visual-cpp-build-tools/ -[git-cli]: https://git-scm.com/download/win/ +[gha_md_valid]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings [pep8]: https://www.python.org/dev/peps/pep-0008/ [isort]: https://pycqa.github.io/isort/ [sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html -[runbook]: https://Git2S3-docs.vigneshrao.com/ - - - -[label-python]: https://img.shields.io/badge/Made%20with-Python-blue?style=for-the-badge&logo=Python -[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-orange -[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg - -[label-language-ct]: https://img.shields.io/github/languages/count/thevickypedia/Git2S3 -[label-code-coverage]: https://img.shields.io/github/languages/top/thevickypedia/Git2S3 - -[label-license]: https://img.shields.io/github/license/thevickypedia/Git2S3 - -[label-stars]: https://img.shields.io/github/stars/thevickypedia/Git2S3 -[label-forks]: https://img.shields.io/github/forks/thevickypedia/Git2S3 -[label-watchers]: https://img.shields.io/github/watchers/thevickypedia/Git2S3 - -[label-repo-size]: https://img.shields.io/github/repo-size/thevickypedia/Git2S3 -[label-code-size]: https://img.shields.io/github/languages/code-size/thevickypedia/Git2S3 -[label-code-line]: http://Git2S3.vigneshrao.com/line-count?badge=true -[label-file-count]: http://Git2S3.vigneshrao.com/file-count?badge=true - -[label-issues-closed]: https://img.shields.io/github/issues-closed-raw/thevickypedia/Git2S3 -[label-issues-raw]: https://img.shields.io/github/issues-raw/thevickypedia/Git2S3 -[label-pr-closed]: https://img.shields.io/github/issues-pr-closed-raw/thevickypedia/Git2S3 -[label-pr-raw]: https://img.shields.io/github/issues-pr-raw/thevickypedia/Git2S3 - -[label-file-count]: https://tokei.rs/b1/github/thevickypedia/Git2S3?category=files -[label-line-of-code]: https://tokei.rs/b1/github/thevickypedia/Git2S3?category=code - -[label-stats-Modules]: https://img.shields.io/github/search/thevickypedia/Git2S3/module -[label-stats-Python]: https://img.shields.io/github/search/thevickypedia/Git2S3/.py -[label-stats-Threads]: https://img.shields.io/github/search/thevickypedia/Git2S3/thread -[label-stats-Listener]: https://img.shields.io/github/search/thevickypedia/Git2S3/listener -[label-stats-Speaker]: https://img.shields.io/github/search/thevickypedia/Git2S3/speaker -[label-stats-Bash]: https://img.shields.io/github/search/thevickypedia/Git2S3/.sh -[label-stats-AppleScript]: https://img.shields.io/github/search/thevickypedia/Git2S3/.scpt -[label-stats-Make]: https://img.shields.io/github/search/thevickypedia/Git2S3/Makefile - -[label-actions-pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment/badge.svg -[label-actions-pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml/badge.svg - -[label-pypi]: https://img.shields.io/pypi/v/git2s3 -[label-pypi-format]: https://img.shields.io/pypi/format/Git2S3 -[label-pypi-status]: https://img.shields.io/pypi/status/Git2S3 - -[label-github-repo-created]: https://img.shields.io/date/1599432310 -[label-github-commit-activity]: https://img.shields.io/github/commit-activity/y/thevickypedia/Git2S3 -[label-github-last-commit]: https://img.shields.io/github/last-commit/thevickypedia/Git2S3 -[label-github-last-release]: https://img.shields.io/github/release-date/thevickypedia/Git2S3 - -[label-active-development]: https://img.shields.io/badge/Development%20Level-Actively%20Developed-success.svg -[label-actively-maintained]: https://img.shields.io/badge/Maintenance%20Level-Actively%20Maintained-success.svg -[label-maintainer]: https://img.shields.io/badge/Maintained%20By-Vignesh%20Rao-blue.svg - -[label-askme]: https://img.shields.io/badge/SELECT%20*%20FROM-questions-1abc9c.svg +[pypi]: https://pypi.org/project/git2s3 +[pypi-files]: https://pypi.org/project/git2s3/#files +[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/ +[license]: https://github.com/thevickypedia/git2s3/blob/master/LICENSE +[runbook]: https://thevickypedia.github.io/git2s3/ diff --git a/docs/searchindex.js b/docs/searchindex.js index 1a8078f..20ffd66 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["Git2S3", "Welcome to Git2S3\u2019s documentation!"], "terms": {"backup": [0, 1], "github": [0, 1], "project": 0, "aw": [0, 1], "s3": [0, 1], "platform": 0, "support": 0, "deploy": 0, "recommend": 0, "instal": 0, "python": 0, "3": 0, "10": 0, "11": 0, "us": [0, 1], "dedic": 0, "virtual": 0, "environ": [0, 1], "m": 0, "pip": 0, "initi": 0, "id": [0, 1], "import": 0, "__name__": 0, "__main__": 0, "git": 0, "start": [0, 1], "cli": [0, 1], "help": 0, "usag": 0, "instruct": 0, "docstr": 0, "format": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "requir": 0, "gitvers": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": 0, "pre": 0, "commit": 0, "ensur": 0, "run": 0, "pytest": 0, "gener": [0, 1], "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "file": [0, 1], "includ": [0, 1], "wiki": 0, "page": [0, 1], "sphinx": 0, "5": 0, "1": 0, "recommonmark": 0, "http": [0, 1], "org": [0, 1], "doc": 0, "vigneshrao": 0, "com": [0, 1], "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "kick": 1, "off": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "placehold": 1, "__init__": 1, "commandlin": 1, "none": 1, "command": 1, "line": 1, "entrypoint": 1, "class": 1, "kwarg": 1, "object": 1, "clone": 1, "repositori": 1, "from": 1, "target": 1, "owner": 1, "organ": 1, "instanti": 1, "keyword": 1, "argument": 1, "env": 1, "logger": 1, "bring": 1, "your": 1, "own": 1, "get_all_repo": 1, "dict": 1, "str": 1, "iter": 1, "through": 1, "get": 1, "avail": 1, "yield": 1, "dictionari": 1, "each": 1, "repo": 1, "inform": 1, "worker": 1, "paramet": 1, "json": 1, "payload": 1, "rais": 1, "except": 1, "If": 1, "thread": 1, "fail": 1, "cloner": 1, "concurr": 1, "refer": 1, "commun": 1, "discuss": 1, "44515": 1, "process": 1, "config": 1, "envconfig": 1, "baseset": 1, "var": 1, "pydant": 1, "git_api_url": 1, "api": 1, "endpoint": 1, "fetch": 1, "within": 1, "an": 1, "git_own": 1, "name": 1, "git_token": 1, "token": 1, "privat": 1, "include_gist": 1, "gist": 1, "zipper": 1, "download": 1, "upload": 1, "tar": 1, "zip": 1, "clone_dir": 1, "locat": 1, "store": 1, "local": 1, "debug": 1, "boolean": 1, "flag": 1, "enabl": 1, "level": 1, "log": 1, "doe": 1, "appli": 1, "when": 1, "custom": 1, "i": 1, "option": 1, "stdout": 1, "aws_profile_nam": 1, "profil": 1, "valu": 1, "aws_default_profil": 1, "default": 1, "aws_access_key_id": 1, "access": 1, "kei": 1, "aws_secret_access_kei": 1, "secret": 1, "aws_region_nam": 1, "bucket": 1, "region": 1, "aws_default_region": 1, "creat": 1, "new": 1, "model": 1, "pars": 1, "input": 1, "data": 1, "validationerror": 1, "pydantic_cor": 1, "cannot": 1, "form": 1, "self": 1, "explicitli": 1, "posit": 1, "onli": 1, "allow": 1, "field": 1, "url": 1, "bool": 1, "path": 1, "logopt": 1, "aws_bucket_nam": 1, "classmethod": 1, "parse_clone_dir": 1, "check": 1, "potenti": 1, "variabl": 1, "env_fil": 1, "env_prefix": 1, "extra": 1, "model_computed_field": 1, "classvar": 1, "computedfieldinfo": 1, "A": 1, "comput": 1, "correspond": 1, "index": 1, "modul": 1, "search": 1}, "objects": {"git2s3": [[1, 0, 0, "-", "__init__"], [1, 0, 0, "-", "main"]], "git2s3.__init__": [[1, 1, 1, "", "commandline"]], "git2s3.config": [[1, 2, 1, "", "EnvConfig"]], "git2s3.config.EnvConfig": [[1, 2, 1, "", "Config"], [1, 3, 1, "", "aws_access_key_id"], [1, 3, 1, "", "aws_bucket_name"], [1, 3, 1, "", "aws_profile_name"], [1, 3, 1, "", "aws_region_name"], [1, 3, 1, "", "aws_secret_access_key"], [1, 3, 1, "", "clone_dir"], [1, 3, 1, "", "debug"], [1, 3, 1, "", "git_api_url"], [1, 3, 1, "", "git_owner"], [1, 3, 1, "", "git_token"], [1, 3, 1, "", "include_gist"], [1, 3, 1, "", "log"], [1, 3, 1, "", "model_computed_fields"], [1, 4, 1, "", "parse_clone_dir"], [1, 3, 1, "", "zipper"]], "git2s3.config.EnvConfig.Config": [[1, 3, 1, "", "env_file"], [1, 3, 1, "", "env_prefix"], [1, 3, 1, "", "extra"]], "git2s3.main": [[1, 2, 1, "", "Git2S3"]], "git2s3.main.Git2S3": [[1, 4, 1, "", "cloner"], [1, 4, 1, "", "get_all_repos"], [1, 4, 1, "", "start"], [1, 4, 1, "", "worker"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "titleterms": {"git2s3": [0, 1], "kick": 0, "off": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "content": 1, "instal": 1, "main": 1, "configur": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file +Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["Git2S3", "Welcome to Git2S3\u2019s documentation!"], "terms": {"backup": [0, 1], "github": [0, 1], "project": 0, "aw": [0, 1], "s3": [0, 1], "platform": 0, "support": 0, "deploy": 0, "recommend": 0, "instal": 0, "python": 0, "3": 0, "10": 0, "11": 0, "us": [0, 1], "dedic": 0, "virtual": 0, "environ": [0, 1], "m": 0, "pip": 0, "initi": 0, "id": [0, 1], "import": 0, "__name__": 0, "__main__": 0, "git": 0, "start": [0, 1], "cli": [0, 1], "help": 0, "usag": 0, "instruct": 0, "docstr": 0, "format": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "requir": 0, "gitvers": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": 0, "pre": 0, "commit": 0, "ensur": 0, "run": 0, "pytest": 0, "gener": [0, 1], "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "file": [0, 1], "includ": [0, 1], "wiki": 0, "page": [0, 1], "sphinx": 0, "5": 0, "1": 0, "recommonmark": 0, "http": [0, 1], "org": [0, 1], "thevickypedia": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "kick": 1, "off": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "placehold": 1, "__init__": 1, "commandlin": 1, "none": 1, "command": 1, "line": 1, "entrypoint": 1, "class": 1, "kwarg": 1, "object": 1, "clone": 1, "repositori": 1, "from": 1, "target": 1, "owner": 1, "organ": 1, "instanti": 1, "keyword": 1, "argument": 1, "env": 1, "logger": 1, "bring": 1, "your": 1, "own": 1, "get_all_repo": 1, "dict": 1, "str": 1, "iter": 1, "through": 1, "get": 1, "avail": 1, "yield": 1, "dictionari": 1, "each": 1, "repo": 1, "inform": 1, "worker": 1, "paramet": 1, "json": 1, "payload": 1, "rais": 1, "except": 1, "If": 1, "thread": 1, "fail": 1, "cloner": 1, "concurr": 1, "refer": 1, "com": 1, "commun": 1, "discuss": 1, "44515": 1, "process": 1, "config": 1, "envconfig": 1, "baseset": 1, "var": 1, "pydant": 1, "git_api_url": 1, "api": 1, "endpoint": 1, "fetch": 1, "within": 1, "an": 1, "git_own": 1, "name": 1, "git_token": 1, "token": 1, "privat": 1, "include_gist": 1, "gist": 1, "zipper": 1, "download": 1, "upload": 1, "tar": 1, "zip": 1, "clone_dir": 1, "locat": 1, "store": 1, "local": 1, "debug": 1, "boolean": 1, "flag": 1, "enabl": 1, "level": 1, "log": 1, "doe": 1, "appli": 1, "when": 1, "custom": 1, "i": 1, "option": 1, "stdout": 1, "aws_profile_nam": 1, "profil": 1, "valu": 1, "aws_default_profil": 1, "default": 1, "aws_access_key_id": 1, "access": 1, "kei": 1, "aws_secret_access_kei": 1, "secret": 1, "aws_region_nam": 1, "bucket": 1, "region": 1, "aws_default_region": 1, "creat": 1, "new": 1, "model": 1, "pars": 1, "input": 1, "data": 1, "validationerror": 1, "pydantic_cor": 1, "cannot": 1, "form": 1, "self": 1, "explicitli": 1, "posit": 1, "onli": 1, "allow": 1, "field": 1, "url": 1, "bool": 1, "path": 1, "logopt": 1, "aws_bucket_nam": 1, "classmethod": 1, "parse_clone_dir": 1, "check": 1, "potenti": 1, "variabl": 1, "env_fil": 1, "env_prefix": 1, "extra": 1, "model_computed_field": 1, "classvar": 1, "computedfieldinfo": 1, "A": 1, "comput": 1, "correspond": 1, "index": 1, "modul": 1, "search": 1}, "objects": {"git2s3": [[1, 0, 0, "-", "__init__"], [1, 0, 0, "-", "main"]], "git2s3.__init__": [[1, 1, 1, "", "commandline"]], "git2s3.config": [[1, 2, 1, "", "EnvConfig"]], "git2s3.config.EnvConfig": [[1, 2, 1, "", "Config"], [1, 3, 1, "", "aws_access_key_id"], [1, 3, 1, "", "aws_bucket_name"], [1, 3, 1, "", "aws_profile_name"], [1, 3, 1, "", "aws_region_name"], [1, 3, 1, "", "aws_secret_access_key"], [1, 3, 1, "", "clone_dir"], [1, 3, 1, "", "debug"], [1, 3, 1, "", "git_api_url"], [1, 3, 1, "", "git_owner"], [1, 3, 1, "", "git_token"], [1, 3, 1, "", "include_gist"], [1, 3, 1, "", "log"], [1, 3, 1, "", "model_computed_fields"], [1, 4, 1, "", "parse_clone_dir"], [1, 3, 1, "", "zipper"]], "git2s3.config.EnvConfig.Config": [[1, 3, 1, "", "env_file"], [1, 3, 1, "", "env_prefix"], [1, 3, 1, "", "extra"]], "git2s3.main": [[1, 2, 1, "", "Git2S3"]], "git2s3.main.Git2S3": [[1, 4, 1, "", "cloner"], [1, 4, 1, "", "get_all_repos"], [1, 4, 1, "", "start"], [1, 4, 1, "", "worker"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "titleterms": {"git2s3": [0, 1], "kick": 0, "off": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "content": 1, "instal": 1, "main": 1, "configur": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file diff --git a/pre_commit.sh b/pre_commit.sh old mode 100644 new mode 100755 index 98cb261..9d19fc5 --- a/pre_commit.sh +++ b/pre_commit.sh @@ -8,7 +8,9 @@ clean_docs() { directory="docs" file_to_keep="CNAME" if [ -e "${directory}/${file_to_keep}" ]; then - find "${directory}" ! -name "${file_to_keep}" -mindepth 1 -delete + find "${directory}" -mindepth 1 ! -name "${file_to_keep}" -exec rm -rf {} + + else + find "${directory}" -mindepth 1 -exec rm -rf {} + fi }