| Name | git2s3 JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | Backup GitHub projects to AWS S3 |
| upload_time | 2024-08-01 22:56:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
git2s3
backup
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
boto3
botocore
click
GitPython
pydantic
pydantic-settings
PyYAML
requests
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Git2S3
Backup GitHub projects to AWS S3
![Python][label-pyversion]
**Platform Supported**
![Platform][label-platform]
**Deployments**
[![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]
[![Pypi-status][label-pypi-status]][pypi]
## Kick off
**Recommendations**
- Install `python` [3.10] or [3.11]
- Use a dedicated [virtual environment]
**Install Git2S3**
```shell
python -m pip install git2s3
```
**Initiate - IDE**
```python
import git2s3
if __name__ == '__main__':
git = git2s3.Git2S3()
git.start()
```
**Initiate - CLI**
```shell
git2s3 start
```
> Use `git2s3 --help` for usage instructions.
## Environment Variables
<details>
<summary><strong>Sourcing environment variables from an env file</strong></summary>
> _By default, `Git2S3` will look for a `.env` file in the current working directory._<br>
> Refer [samples] directory for examples.
</details>
- **GIT_API_URL** - GitHub API endpoint. Defaults to `https://api.github.com/`
- **GIT_OWNER** - GitHub profile owner or organization name.
- **GIT_TOKEN** - GitHub token to get ALL repos (including private).
- **GIT_IGNORE** - List of repositories/gists to ignore. Defaults to `[]`
- **SOURCE** - Source options `[repo, gist, wiki]` to back up. Defaults to all.
- **LOG** - Log options to log to a `file` or `stdout`. _Does not apply when custom logger is used_
- **DEBUG** - Boolean flag to enable debug level logging. _Does not apply when custom logger is used_
- **STORE_LOCAL** - Boolean flag to store the backup locally. Defaults to `False`
- **AWS_PROFILE_NAME** - AWS profile name. Uses the CLI config value `AWS_DEFAULT_PROFILE` by default.
- **AWS_ACCESS_KEY_ID** - AWS access key ID. Uses the CLI config value `AWS_ACCESS_KEY_ID` by default.
- **AWS_SECRET_ACCESS_KEY** - AWS secret key. Uses the CLI config value `AWS_SECRET_ACCESS_KEY` by default.
- **AWS_REGION_NAME** - S3 bucket's region. Uses the CLI config value `AWS_DEFAULT_REGION` by default.
- **AWS_BUCKET_NAME** - AWS bucket name to store the backups.
- **AWS_S3_PREFIX** - S3 prefix _(folder like)_ for the backup. Defaults to `github`
- **BOTO3_RETRY_ATTEMPTS** - Number of retries for Boto3 client config. Defaults to `10`
- **BOTO3_RETRY_MODE** - [Boto3 retry configuration][boto3-retry-config] for S3 client. Defaults to `standard`
## Coding Standards
Docstring format: [`Google`][google-docs] <br>
Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
## [Release Notes][release-notes]
**Requirement**
```shell
python -m pip install gitverse
```
**Usage**
```shell
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
```
## Linting
`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL
markdown files (including Wiki pages)
**Requirement**
```shell
python -m pip install sphinx==5.1.1 pre-commit recommonmark
```
**Usage**
```shell
pre-commit run --all-files
```
## Pypi Package
[![pypi-module][label-pypi-package]][pypi-repo]
[https://pypi.org/project/git2s3/][pypi]
## Runbook
[![made-with-sphinx-doc][label-sphinx-doc]][sphinx]
[https://thevickypedia.github.io/git2s3/][runbook]
## License & copyright
© 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-blue
[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
[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/
[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
[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/
[boto3-retry-config]: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/retries.html#available-retry-modes
[samples]: https://github.com/thevickypedia/git2s3/tree/main/samples
Raw data
{
"_id": null,
"home_page": null,
"name": "git2s3",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "git2s3, backup",
"author": null,
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": null,
"platform": null,
"description": "# Git2S3\nBackup GitHub projects to AWS S3\n\n![Python][label-pyversion]\n\n**Platform Supported**\n\n![Platform][label-platform]\n\n**Deployments**\n\n[![pages][label-actions-pages]][gha_pages]\n[![pypi][label-actions-pypi]][gha_pypi]\n[![markdown][label-actions-markdown]][gha_md_valid]\n\n[![Pypi][label-pypi]][pypi]\n[![Pypi-format][label-pypi-format]][pypi-files]\n[![Pypi-status][label-pypi-status]][pypi]\n\n## Kick off\n\n**Recommendations**\n\n- Install `python` [3.10] or [3.11]\n- Use a dedicated [virtual environment]\n\n**Install Git2S3**\n```shell\npython -m pip install git2s3\n```\n\n**Initiate - IDE**\n```python\nimport git2s3\n\n\nif __name__ == '__main__':\n git = git2s3.Git2S3()\n git.start()\n```\n\n**Initiate - CLI**\n```shell\ngit2s3 start\n```\n\n> Use `git2s3 --help` for usage instructions.\n\n## Environment Variables\n\n<details>\n<summary><strong>Sourcing environment variables from an env file</strong></summary>\n\n> _By default, `Git2S3` will look for a `.env` file in the current working directory._<br>\n> Refer [samples] directory for examples.\n\n</details>\n\n- **GIT_API_URL** - GitHub API endpoint. Defaults to `https://api.github.com/`\n- **GIT_OWNER** - GitHub profile owner or organization name.\n- **GIT_TOKEN** - GitHub token to get ALL repos (including private).\n- **GIT_IGNORE** - List of repositories/gists to ignore. Defaults to `[]`\n- **SOURCE** - Source options `[repo, gist, wiki]` to back up. Defaults to all.\n- **LOG** - Log options to log to a `file` or `stdout`. _Does not apply when custom logger is used_\n- **DEBUG** - Boolean flag to enable debug level logging. _Does not apply when custom logger is used_\n- **STORE_LOCAL** - Boolean flag to store the backup locally. Defaults to `False`\n- **AWS_PROFILE_NAME** - AWS profile name. Uses the CLI config value `AWS_DEFAULT_PROFILE` by default.\n- **AWS_ACCESS_KEY_ID** - AWS access key ID. Uses the CLI config value `AWS_ACCESS_KEY_ID` by default.\n- **AWS_SECRET_ACCESS_KEY** - AWS secret key. Uses the CLI config value `AWS_SECRET_ACCESS_KEY` by default.\n- **AWS_REGION_NAME** - S3 bucket's region. Uses the CLI config value `AWS_DEFAULT_REGION` by default.\n- **AWS_BUCKET_NAME** - AWS bucket name to store the backups.\n- **AWS_S3_PREFIX** - S3 prefix _(folder like)_ for the backup. Defaults to `github`\n- **BOTO3_RETRY_ATTEMPTS** - Number of retries for Boto3 client config. Defaults to `10`\n- **BOTO3_RETRY_MODE** - [Boto3 retry configuration][boto3-retry-config] for S3 client. Defaults to `standard`\n\n## Coding Standards\nDocstring format: [`Google`][google-docs] <br>\nStyling conventions: [`PEP 8`][pep8] and [`isort`][isort]\n\n## [Release Notes][release-notes]\n**Requirement**\n```shell\npython -m pip install gitverse\n```\n\n**Usage**\n```shell\ngitverse-release reverse -f release_notes.rst -t 'Release Notes'\n```\n\n## Linting\n`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL\nmarkdown files (including Wiki pages)\n\n**Requirement**\n```shell\npython -m pip install sphinx==5.1.1 pre-commit recommonmark\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Pypi Package\n[![pypi-module][label-pypi-package]][pypi-repo]\n\n[https://pypi.org/project/git2s3/][pypi]\n\n## Runbook\n[![made-with-sphinx-doc][label-sphinx-doc]][sphinx]\n\n[https://thevickypedia.github.io/git2s3/][runbook]\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][license]\n\n[//]: # (Labels)\n\n[label-actions-markdown]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml/badge.svg\n[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-git2s3-blue?style=for-the-badge&logo=Python\n[label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx\n[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue\n[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg\n[label-actions-pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment/badge.svg\n[label-actions-pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml/badge.svg\n[label-pypi]: https://img.shields.io/pypi/v/git2s3\n[label-pypi-format]: https://img.shields.io/pypi/format/git2s3\n[label-pypi-status]: https://img.shields.io/pypi/status/git2s3\n\n[3.10]: https://docs.python.org/3/whatsnew/3.10.html\n[3.11]: https://docs.python.org/3/whatsnew/3.11.html\n[virtual environment]: https://docs.python.org/3/tutorial/venv.html\n[release-notes]: https://github.com/thevickypedia/git2s3/blob/master/release_notes.rst\n[gha_pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment\n[gha_pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml\n[gha_md_valid]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml\n[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings\n[pep8]: https://www.python.org/dev/peps/pep-0008/\n[isort]: https://pycqa.github.io/isort/\n[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html\n[pypi]: https://pypi.org/project/git2s3\n[pypi-files]: https://pypi.org/project/git2s3/#files\n[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/\n[license]: https://github.com/thevickypedia/git2s3/blob/master/LICENSE\n[runbook]: https://thevickypedia.github.io/git2s3/\n[boto3-retry-config]: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/retries.html#available-retry-modes\n[samples]: https://github.com/thevickypedia/git2s3/tree/main/samples\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Backup GitHub projects to AWS S3",
"version": "0.0.4",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/git2s3/issues",
"Docs": "https://thevickypedia.github.io/git2s3",
"Homepage": "https://github.com/thevickypedia/git2s3",
"Release Notes": "https://github.com/thevickypedia/git2s3/blob/main/release_notes.rst",
"Source": "https://github.com/thevickypedia/git2s3"
},
"split_keywords": [
"git2s3",
" backup"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b0a816598b8fbb41f7fe7bbeb4dec9737c8761cb68f10284211b03db67120a05",
"md5": "8ed2fa61ef3ee25ed23204ce2d4de033",
"sha256": "21490b3b3365926cb86e1a87760cfa3070eb8c6eedbd37ea096cdf96aafe3c46"
},
"downloads": -1,
"filename": "git2s3-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ed2fa61ef3ee25ed23204ce2d4de033",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15603,
"upload_time": "2024-08-01T22:56:48",
"upload_time_iso_8601": "2024-08-01T22:56:48.808805Z",
"url": "https://files.pythonhosted.org/packages/b0/a8/16598b8fbb41f7fe7bbeb4dec9737c8761cb68f10284211b03db67120a05/git2s3-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-01 22:56:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "git2s3",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "boto3",
"specs": [
[
"~=",
"1.34.133"
]
]
},
{
"name": "botocore",
"specs": [
[
"~=",
"1.34.133"
]
]
},
{
"name": "click",
"specs": [
[
"~=",
"8.1.7"
]
]
},
{
"name": "GitPython",
"specs": [
[
"~=",
"3.1.43"
]
]
},
{
"name": "pydantic",
"specs": [
[
"~=",
"2.7.4"
]
]
},
{
"name": "pydantic-settings",
"specs": [
[
"~=",
"2.3.4"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"~=",
"6.0.1"
]
]
},
{
"name": "requests",
"specs": [
[
"~=",
"2.32.3"
]
]
}
],
"lcname": "git2s3"
}
