Skip to content

Commit fa9c14b

Browse files
SmileyJoeSmileyJoe
committed
Adding read me, license, comments
1 parent ef63600 commit fa9c14b

8 files changed

Lines changed: 298 additions & 2 deletions

File tree

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Github backup
2+
3+
Python script that will clone all repos owned by the user token, private and public, or pull in any updates if the repo is already cloned.
4+
5+
Note:
6+
This is meant as a backup, the repos it clones should not be updated as there is nothing in place to handle conflicts or to push up changes
7+
8+
## Setup
9+
10+
- Duplicate `example_config.yaml` and rename it to `config.yaml`
11+
- Update `config.yaml` with your keys/settings
12+
- Install the requirements with `pip install -r requirements.txt`
13+
- See [here](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) for generating a github token
14+
- For the pushover api token, a new app will need to be registered [here](https://pushover.net/apps/build)
15+
16+
## Translations
17+
18+
- Copy a language file, rename the 2 letter code and translate it, the file can them be specified in `config.yaml`

‎config.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,26 @@
33
import yaml
44

55

6+
# Loads in the yaml config
7+
#
8+
# Usage:
9+
# config = Config().load()
610
class Config:
711

812
@staticmethod
13+
# Load the config
914
def load():
15+
# load the config into a dict
1016
config = Config._load_yaml("config.yaml")
17+
# using the language_file config, load the language file into a dict
1118
config["language"] = Config._load_yaml(config["language_file"] + ".yaml")
1219

20+
# convert the dict to json, then parse the json into an object, this
21+
# lets us reference config as config.repo_dir instead of config["repo_dir"]
1322
return json.loads(json.dumps(config), object_hook=lambda d: SimpleNamespace(**d))
1423

1524
@staticmethod
25+
# Parse the given yaml file into a dict
1626
def _load_yaml(file_name):
1727
file = open(file_name, "r")
1828
data = yaml.load(file, Loader=yaml.FullLoader)

‎db.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,34 @@
33
import json
44

55

6+
# Simple json file to be used for storing data between runs
67
class Db:
78
FILE = "db.json"
89

910
def __init__(self):
11+
# if the file doesn't exist yet, set the defaults
1012
if not os.path.isfile(self.FILE):
1113
self._db = {
1214
"last_run": datetime(1, 1, 1, 0, 0, 0, 0, timezone.utc).isoformat()
1315
}
16+
# else parse the json into a dict
1417
else:
1518
file = open(self.FILE, "r")
1619
self._db = json.load(file)
1720
file.close()
1821

1922
@property
23+
# this is a timestamp in UTC+0 in isoformat for the last time the script ran
24+
# it is used to ignore repos that haven't been updated since when the script is called again
2025
def last_run(self):
2126
return self._db["last_run"]
2227

2328
@last_run.setter
29+
# sets the property from a datetime object
2430
def last_run(self, last_run):
2531
self._db["last_run"] = last_run.isoformat()
2632

33+
# save the json to the file
2734
def save(self):
2835
with open(self.FILE, 'w') as f:
2936
json.dump(self._db, f, indent=4)

‎example_config.yaml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# settings for what to log to the terminal
2+
logging:
3+
# if this is false, the specific types don't matter as nothing is logged
4+
enabled: true
5+
# what actions to log
6+
type:
7+
cloned: true
8+
updated: true
9+
skipped: true
10+
11+
# path to the directory where the repos will be cloned
12+
repo_dir: <directory_name>
13+
# language file to use
14+
language_file: language_en
15+
16+
# settings for github
17+
github:
18+
# auth token needs to have full repo permission so private repos can be retrieved
19+
token: <github_token>
20+
21+
# settings for pushover to get a notification when the script is finished
22+
pushover:
23+
# user to send the message to
24+
user: <pushover_user_key>
25+
# api token for the app that will be sending the message
26+
api_token: <pushover_app_api_token>
27+
# max character count for a message is 1024, set this to less if you want truncated messages
28+
message_limit: 1024
29+
# which list of repos to include base on the action
30+
notification_type:
31+
cloned: true
32+
updated: true
33+
skipped: true

‎language_en.yaml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1+
# titles for the different actions, used in logging etc
12
status:
23
cloned: Cloned
34
updated: Updated
45
skipped: Skipped
56

7+
# language used for pushover notifications
68
pushover:
9+
# {title} is replaced with either success or fail title
710
title: Github sync {title}
811
success:
9-
title: Success!
12+
title: success!
13+
# variables are replaced based on data from the script running
1014
message: |
1115
Cloned: {count_cloned}
1216
Updated: {count_updated}
1317
Skipped: {count_skipped}
1418
{list_cloned}{list_updated}{list_skipped}
1519
fail:
16-
title: Failed!
20+
title: failed!
1721
message: Something went wrong

0 commit comments

Comments
 (0)