Changed directory structure to use pyscaffold

22 files changed, 692 insertions, 28 deletions

diff --git a/.coveragerc b/.coveragerc
new file mode 100644
index 0000000..142021c
--- /dev/null
+++ b/.coveragerc
@@ -0,0 +1,23 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+source = youtube_podcaster
+# omit = bad_file.py
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
diff --git a/.gitignore b/.gitignore
index 1d7362c..f41c0ad 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,8 +1,41 @@
-downloads/
+# Temporary and binary files
+*~
+*.py[cod]
+*.so
+*.cfg
+!setup.cfg
+*.orig
+*.log
+*.pot
+__pycache__/*
+.cache/*
+.*.swp
 
-feeds.save
-youtube-podcaster.json
+# Project files
+.ropeproject
+.project
+.pydevproject
+.settings
+.idea
 
-*.pyc
-*.xml
-*.sw?
+# Package files
+*.egg
+*.eggs/
+.installed.cfg
+*.egg-info
+
+# Unittest and coverage
+htmlcov/*
+.coverage
+.tox
+junit.xml
+coverage.xml
+
+# Build and docs folder/files
+build/*
+dist/*
+sdist/*
+docs/api/*
+docs/_build/*
+cover/*
+MANIFEST
diff --git a/AUTHORS.rst b/AUTHORS.rst
new file mode 100644
index 0000000..b4de63b
--- /dev/null
+++ b/AUTHORS.rst
@@ -0,0 +1,5 @@
+==========
+Developers
+==========
+
+* Tom van der Lee <t0m.vd.l33@gmail.com>
diff --git a/CHANGES.rst b/CHANGES.rst
new file mode 100644
index 0000000..889f44c
--- /dev/null
+++ b/CHANGES.rst
@@ -0,0 +1,4 @@
+=========
+Changelog
+=========
+
diff --git a/README.md b/README.md
deleted file mode 100644
index 8028dfd..0000000
--- a/README.md
+++ /dev/null
@@ -1,22 +0,0 @@
-# YouTube Podcaster
-Lets you covert YouTube-playlists to RSS podcast feeds and serve them.
-
-## Features
-* Check playlists on HTTP-request
-* Downloads videos and converts them to Ogg Vorbis files.
-* Serve RSS feed
-
-## What it doesn't do (at the moment)
-* Convert to mp3, mp4 or any other audio/video format
-* Serve the downloaded audio files (needs to be done by an other server)
-
-## Dependencies
-* [youtube-dl](https://github.com/rg3/youtube-dl)
-* [python-feedgen](https://github.com/lkiesow/python-feedgen)
-
-## To do
-* Add comments/documentation
-* Support multiple audio/video formats
-
-## LICENSE
-YouTube Podcaster is licensed under the MIT License, see the LICENSE file for more info.
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..b485fbb
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,36 @@
+YouTube Podcaster
+=================
+
+Lets you covert YouTube-playlists to RSS podcast feeds and serve them.
+
+Features
+--------
+
+-  Check playlists on HTTP-request
+-  Downloads videos and converts them to Ogg Vorbis files.
+-  Serve RSS feed
+
+What it doesn't do (at the moment)
+----------------------------------
+
+-  Convert to mp3, mp4 or any other audio/video format
+-  Serve the downloaded audio files (needs to be done by an other
+   server)
+
+Dependencies
+------------
+
+-  `youtube-dl <https://github.com/rg3/youtube-dl>`__
+-  `python-feedgen <https://github.com/lkiesow/python-feedgen>`__
+
+To do
+-----
+
+-  Add comments/documentation
+-  Support multiple audio/video formats
+
+LICENSE
+-------
+
+YouTube Podcaster is licensed under the MIT License, see the LICENSE
+file for more info.
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..e8b986c
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+        @echo "Please use \`make <target>' where <target> is one of"
+        @echo "  html       to make standalone HTML files"
+        @echo "  dirhtml    to make HTML files named index.html in directories"
+        @echo "  singlehtml to make a single large HTML file"
+        @echo "  pickle     to make pickle files"
+        @echo "  json       to make JSON files"
+        @echo "  htmlhelp   to make HTML files and a HTML help project"
+        @echo "  qthelp     to make HTML files and a qthelp project"
+        @echo "  devhelp    to make HTML files and a Devhelp project"
+        @echo "  epub       to make an epub"
+        @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+        @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+        @echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+        @echo "  text       to make text files"
+        @echo "  man        to make manual pages"
+        @echo "  texinfo    to make Texinfo files"
+        @echo "  info       to make Texinfo files and run them through makeinfo"
+        @echo "  gettext    to make PO message catalogs"
+        @echo "  changes    to make an overview of all changed/added/deprecated items"
+        @echo "  xml        to make Docutils-native XML files"
+        @echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+        @echo "  linkcheck  to check all external links for integrity"
+        @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+        rm -rf $(BUILDDIR)/*
+
+html:
+        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+        @echo
+        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+        @echo
+        @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+        $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+        @echo
+        @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."