Merge pull request #1 from secynic/dev

.gitignore

@@ -0,0 +1,39 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+__pycache__
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+MANIFEST
+.idea

CHANGES.rst

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+0.1.0 (2016-08-29)
+------------------
+
+- Initial release

CONTRIBUTING.rst

@@ -0,0 +1,85 @@
+============
+Contributing
+============
+
+****************
+Issue submission
+****************
+
+| Issues are tracked on GitHub:
+| https://github.com/secynic/nfsinkhole/issues
+
+
+Follow the guidelines detailed in the appropriate section below. As a general
+rule of thumb, provide as much information as possible when submitting issues.
+
+Bug reports
+===========
+
+- Title should be a short, descriptive summary of the bug
+- Include the OS, Python, and nfsinkhole versions affected
+- Provide a context (with code example) in the description of your issue. What
+  are you attempting to do?
+- Include the full obfuscated output. Make sure to set DEBUG logging:
+  ::
+
+    import logging
+    LOG_FORMAT = ('[%(asctime)s] [%(levelname)s] [%(filename)s:%(lineno)s] '
+       '[%(funcName)s()] %(message)s')
+    logging.basicConfig(level=logging.DEBUG, format=LOG_FORMAT)
+- Include sources of information with links or screenshots
+- Do you have a suggestion on how to fix the bug?
+
+Feature Requests
+================
+
+- Title should be a short, descriptive summary of the feature requested
+- Provide use case examples
+- Include sources of information with links or screenshots
+- Do you have a suggestion on how to implement the feature?
+
+.. _contrib-testing:
+
+Testing
+=======
+
+Testing code and infrastructure is in progress.
+
+Questions
+=========
+
+I am happy to answer any questions and provide assistance where possible.
+Please be clear and concise. Provide examples when possible. Check the
+nfsinkhole `documentation <https://nfsinkhole.readthedocs.io/en/latest>`_ and the
+`issue tracker <https://github.com/secynic/nfsinkhole/issues>`_ before asking a
+question.
+
+*************
+Pull Requests
+*************
+
+What to include
+===============
+
+Aside from the core code changes, it is helpful to provide the following
+(where applicable):
+
+- Unit tests
+- Examples
+- Sphinx configuration changes in /docs
+- Requirements (python2.6.txt, etc)
+
+Guidelines
+==========
+
+- Title should be a short, descriptive summary of the changes
+- Follow `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_ where possible.
+- Follow the `Google docstring style guide
+  <https://google.github.io/styleguide/pyguide.html#Comments>`_ for
+  comments
+- Must be compatible with Python 2.6, 2.7, and 3+
+- Must not break OS compatibility for RHEL 6/7, CentOS 6/7
+- Break out reusable code to functions
+- Make your code easy to read and comment where necessary
+- Reference the GitHub issue number in the description (e.g., Issue #01)
+- When running nosetests, make sure to follow :ref:`contrib-testing`

LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Philip Hane
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -0,0 +1 @@
+include *.txt *.rst