added config file support, closes #87

Author: jayfk

CHANGELOG.md

@@ -5,7 +5,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## 0.7.0 [2016-07-31]
 - Added markdown support.
 - Added upgrade command.
-- Added support for localtime. 
+- Added support for localtime.
+- Added support for a config file.
 
 ## 0.6.0 [2016-07-26]
 - Added an option to automate the update process.

docs/customizing.md

@@ -9,15 +9,20 @@ or, on the website, select the `gh-pages` branch before editing things.
 
 ### Template
 
-The template is fully customizable, edit `template.html`.
+Don't edit the `template.html` file directly, as it will change with each upgrade.
 
-### Logo
+Instead, create a file called `config.json` in the root of your repository and change the defaults. Don't forget to run `statuspage update` afterwards.
 
-Add a `logo.png` to your repo's root and change `template.html` to point to that file.
+```javascript
+{
+    "footer": "Status page hosted by GitHub, generated with <a href='https://github.com/jayfk/statuspage'>jayfk/statuspage</a>",
+    "logo": "https://raw.githubusercontent.com/jayfk/statuspage/master/template/logo.png",
+    "title": "Status",
+    "favicon": "https://raw.githubusercontent.com/jayfk/statuspage/master/template/favicon.png"
+}
+```
 
-### CSS
-
-CSS is located at `style.css` in the root directory. Just edit it and commit the file.
+Please note: `config.json` has to be valid JSON. The best way to validate it online is at [jsonlint.com](http://jsonlint.com/).
 
 ### Use a subdomain
 

statuspage/statuspage.py

@@ -13,6 +13,7 @@
 from tqdm import tqdm
 from collections import OrderedDict
 import markdown2
+import json
 
 __version__ = "0.6.0"
 
@@ -39,6 +40,13 @@
     "statuspage.js",
 ]
 
+DEFAULT_CONFIG = {
+    "footer": "Status page hosted by GitHub, generated with <a href='https://github.com/jayfk/statuspage'>jayfk/statuspage</a>",
+    "logo": "https://raw.githubusercontent.com/jayfk/statuspage/master/template/logo.png",
+    "title": "Status",
+    "favicon": "https://raw.githubusercontent.com/jayfk/statuspage/master/template/favicon.png"
+}
+
 
 @click.group()
 @click.version_option(__version__, '-v', '--version')
@@ -85,7 +93,7 @@ def run_upgrade(name, token, org):
     click.echo("Upgrading...")
 
     repo = get_repo(token=token, name=name, org=org)
-    files = [file.path for file in repo.get_dir_contents("/", ref="gh-pages")]
+    files = get_files(repo=repo)
     head_sha = repo.get_git_ref("heads/gh-pages").object.sha
 
     # add all the template files to the gh-pages branch
@@ -132,9 +140,10 @@ def run_update(name, token, org):
     panels = get_panels(systems)
 
     # render the template
+    config = get_config(repo)
     template = Template(template_file.decoded_content.decode("utf-8"))
     content = template.render({
-        "systems": systems, "incidents": incidents, "panels": panels
+        "systems": systems, "incidents": incidents, "panels": panels, "config": config
     })
 
     # create/update the index.html with the template
@@ -283,6 +292,31 @@ def iter_systems(labels):
             yield label.name
 
 
+def get_files(repo):
+    """
+    Get a list of all files.
+    """
+    return [file.path for file in repo.get_dir_contents("/", ref="gh-pages")]
+
+
+def get_config(repo):
+    """
+    Get the config for the repo, merged with the default config. Returns the default config if
+    no config file is found.
+    """
+    files = get_files(repo)
+    config = DEFAULT_CONFIG
+    if "config.json" in files:
+        # get the config file, parse JSON and merge it with the default config
+        config_file = repo.get_file_contents('/config.json', ref="gh-pages")
+        try:
+            repo_config = json.loads(config_file.decoded_content.decode("utf-8"))
+            config.update(repo_config)
+        except ValueError:
+            click.secho("WARNING: Unable to parse config file. Using defaults.", fg="yellow")
+    return config
+
+
 def get_severity(labels):
     label_map = dict(COLORED_LABELS)
     for label in labels:

statuspage/template/template.html

@@ -3,12 +3,11 @@
 	<head>
 		<meta charset="utf-8">
 		<meta name="robots" content="index, follow">
-		<title>Status</title>
+		<title>{{ config.title }}</title>
 		<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic">
 		<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/3.0.3/normalize.css">
 		<link rel="stylesheet" href="style.css">
-		{# upload your own favicon.png to the root of your repo and replace with href="favicon.png" #}
-		<link rel="icon" href="https://raw.githubusercontent.com/pyupio/statuspage/master/template/favicon.png">
+		<link rel="icon" href="{{ config.favicon }}">
 	</head>
 	<body>
 
@@ -18,9 +17,8 @@
 				<section class="container">
 
 					<a class="navigation-title" href="">
-						{# upload your own logo.png to the root of your repo and replace with src="logo.png" #}
-						<img class="img" src="https://raw.githubusercontent.com/pyupio/statuspage/master/template/logo.png" height="30">
-						<h1 class="title">Status</h1>
+						<img class="img" src="{{ config.logo }}" height="30">
+						<h1 class="title">{{ config.title }}</h1>
 					</a>
 
 
@@ -83,8 +81,7 @@ <h4>Incidents</h4>
 			<footer class="footer">
 				<section class="container">
 					<hr/>
-					{# you might want to replace this with a link to your website or something #}
-					<p>Status page hosted by GitHub, generated with <a href="https://github.com/jayfk/statuspage">jayfk/statuspage</a></p>
+					<p>{{ config.footer }}</p>
 				</section>
 			</footer>