changelog

Author: peakwinter

CHANGELOG

@@ -0,0 +1,20 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.0.0] - 2016-08-19
+### Changed
+- Some API changes:
+  - `all()` methods replaced with `children` property
+  - `as_list()` methods replaced with `as_list` property
+  - `as_dict()` methods replaced with `as_dict` property
+  - `as_block()` methods replaced with `as_strings` property
+  - `conf.server` convenience property, for getting first server found in the Conf
+- Added `inline` property to `Comment`: set to `True` if you want the comment to be appended to the end of the previous line on dump
+- Added loading of inline code comments.
+- Cleaned code for full PEP8 compatibility and added comments.
+- Added simple tests.
+
+
+### Fixed
+- Fixed a bug where unexpected behaviour would occur when a pound symbol was used inside a key value.

README.md

@@ -37,18 +37,18 @@ Load an nginx serverblock from a file:
 
     >>> import nginx
     >>> c = nginx.loadf('/etc/nginx/sites-available/testsite')
-    >>> c.all()
+    >>> c.children
     [<main.Server object at 0x7f1ed4573890>]
-    >>> c.servers[0].all()
+    >>> c.server.children
     [<main.Comment object at 0x7f1ed45736d0>, <main.Key object at 0x7f1ed4573750>, <main.Key object at 0x7f1ed4573790>, <main.Location object at 0x7f1ed4573850>]
-    >>> c.as_dict()
+    >>> c.as_dict
     {'conf': [{'server': [{'#': 'This is a test comment'}, {'server_name': 'localhost'}, {'root': '/srv/http'}, {'location /': [{'allow': 'all'}]}]}]}
 
 Format an nginx serverblock into a string (change the amount of spaces (or tabs) for each indentation level by modifying `nginx.INDENT` first):
 
-    >>> c.all()
+    >>> c.servers
     [<main.Server object at 0x7f1ed4573890>]
-    >>> c.as_block()
+    >>> c.as_strings
     ['server {\n', '    # This is a test comment\n', '    server_name localhost;\n', '    root /srv/http;\n', '\n    location / {\n', '        allow all;\n', '    }\n\n', '}\n']
 
 Find where you put your keys:

setup.py

@@ -10,10 +10,10 @@
     author_email='jacob@peakwinter.net',
     url='https://github.com/peakwinter/python-nginx',
     py_modules=['nginx'],
-    keywords = ['nginx', 'web servers', 'serverblock', 'server block'],
-    download_url = 'https://github.com/peakwinter/python-nginx/archive/0.2.tar.gz',
-    license = 'GPLv3',
-    classifiers = [
+    keywords=['nginx', 'web servers', 'serverblock', 'server block'],
+    download_url='https://git.coderouge.co/coderouge/python-nginx/repository/archive.zip?ref=master',
+    license='GPLv3',
+    classifiers=[
         "Development Status :: 5 - Production/Stable",
         "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
         "Operating System :: Unix",

tests.py

@@ -74,6 +74,11 @@ def test_reflection(self):
         out_data = '\n' + nginx.dumps(inp_data)
         self.assertEqual(TESTBLOCK, out_data)
 
+    def test_filtering(self):
+        data = nginx.loads(TESTBLOCK)
+        self.assertEqual(len(data.server.filter('mykey')), 1)
+        self.assertEqual(data.server.filter('nothere'), [])
+
 
 if __name__ == '__main__':
     unittest.main()