Merge pull request #26 from jesseops/docs/quickstart

Docs/quickstart

Author: jesseops

.gitignore

@@ -11,3 +11,4 @@ virtualenv
 .virtualenv
 *.venv
 _build
+.tox

.travis.yml

@@ -4,7 +4,7 @@ python:
   - "3.3"
   - "3.4"
   - "3.5"
-  - "3.6-dev"
+  - "3.6"
   - "pypy"
   - "pypy3"
 

docs/conf.py

@@ -50,7 +50,7 @@
 
 # General information about the project.
 project = u'YACT'
-copyright = u'2016, Jesse Roberts'
+copyright = u'2017, Jesse Roberts'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/dev/authors.rst

@@ -24,7 +24,7 @@ changed.::
 
     >>> config = yact.from_file('my-config.yaml', auto_reload=True)
 
-YACT is tested against Python 2.7, 3.3-3.6(dev) and PyPy.
+YACT is tested against Python 2.7, 3.3-3.6 and PyPy.
 
 
 Usage Guide

docs/index.rst

@@ -37,14 +37,14 @@ to search in if it's not in a standard location.
 Example
 ~~~~~~~
 
-Standard loading
+Standard loading:
 
     >>> import yact
     >>> config = yact.from_file('my-config.yaml')
     >>> print(config.filename)
     '/etc/my-config.yaml'
 
-Explicit directory
+Explicit directory:
 
     >>> config = yact.from_file('my-config.yaml', directory='/opt/my-app')
     >>> print(config.filename)
@@ -53,3 +53,23 @@ Explicit directory
 
 Saving Config
 -------------
+
+There's no need! As long as you use the standard methods of updating a config entry,
+YACT will automatically save your changes to the original configuration file.
+
+Example:
+~~~~~~~~
+
+    >>> config = yact.from_file('mynewconfig.yaml', create_if_missing=True)
+    >>> config.set('my.new.setting', True)
+
+Done!
+
+
+Auto Reloading
+--------------
+
+YACT will watch for changes to your config files and automatically reload your configuration
+without any extra code on your end. Just set `auto_reload` to `True` when loading your config:
+
+    >>> config = yact.from_file('myconfig.yaml', auto_reload=True)

docs/usage/quickstart.rst

@@ -6,7 +6,6 @@
 __version__ = "0.5.1"
 __desc__ = """Yet Another Config Tool"""
 
-
 with open(path.join(here, 'requirements.txt')) as r:
     __requires__ = [x.strip() for x in r.readlines() if not x.startswith('--')]
 
@@ -18,7 +17,7 @@
     author="Jesse Roberts",
     author_email="[email protected]",
     version=__version__,
-    url="https://github.com/dreadpirate15/yact",
+    url="https://github.com/jesseops/yact",
     install_requires=__requires__,
     extras_require={'test': ['nosetests']},
     packages=['yact'],
@@ -37,5 +36,6 @@
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
     ]
 )

setup.py

@@ -7,7 +7,6 @@
 from threading import Lock, Thread
 from datetime import datetime, timedelta
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -82,6 +81,7 @@ class Config(object):
     While not currently tested, unsafe loading of YAML
     files is supported using the unsafe flag.
     """
+
     def __init__(self, filename, unsafe=False, auto_reload=False):
         self.unsafe = unsafe
         self.auto_reload = auto_reload
@@ -95,11 +95,13 @@ def __init__(self, filename, unsafe=False, auto_reload=False):
     def start_file_watch(self, interval=5):
         if self._file_watcher and self._file_watcher.is_alive():
             return True  # No need to create a new watcher
+
         def watcher(config, interval):
             while True:
                 if config.config_file_changed:
                     config.refresh()
                 sleep(interval)
+
         self._file_watcher = Thread(target=watcher, args=(self, interval))
         self._file_watcher.setDaemon(True)
         self._file_watcher.start()
@@ -137,7 +139,6 @@ def set(self, key, value):
         """
         self.__setitem__(key, value)
 
-
     def remove(self, key):
         """
         Remove an item from configuration file