Make configobj a package, moving towards incorporating validate

[robdennis]

Coming out of the discussion from #31, it's important to understand where we see validate fitting in long term. I think this post does a good job of marking this out:

1. Make configobj a package instead of a single configobj.py file, and put validate.py inside of it. Make a separate top-level validate model that raises PendingDeprecationWarning when imported, but otherwise just works as expected. Update the documentation to tell people to do this the correct way, with a note that validate.py used to be a top-level module and is now deprecated. This step can probably come in a later 5.x release.
2. In a later release, keep this exactly the same, except that we'll raise DeprecationWarning instead of PendingDeprecationWarning. This would probably happen in a 6.0 release.
3. Remove validate.py altogether, after the deprecation warnings have been there for awhile. I'm not super concerned about this step, and IMO there should be at least a year between Step 1 and this step to give people who are not pinning their dependency versions (shame on them) time to update their code.

This is something to consider in a 5.1.x release

[jhermann]

Please use "?w=1" on commit diffs, my editor is set to canonize away redundant trailing whitespace.

[jhermann]

Why a "src" directory? See e.g. http://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure

The "tests" dir could be moved down there, too. Which then eases targeted recursive greps and such things. 😉

[EliAndrewC]

(Apologies for the delay, I've been slammed recently with a combination of work and personal projects.)

I originally was going to argue against the use of a src/ directory, but I find the linked article very persuasive, especially points 1, 3, and 4. The rest of the points I'm pretty "meh" on and/or outright disagree with, but the points I do agree with outweigh the others, at least in this case :)

I like what I'm seeing. I checked out the code and poked around and ran tox myself as a sanity check and everything seems good.

I'm going to hold off on accepting the PR for right now because there's another outstanding pull requests which I've been slacking on confirming which was opened first and they might conflict. Either way I hope to have them both handled by the end of this week.

[jhermann]

Fixed a while ago.