Initial commit

.gitignore

@@ -0,0 +1,58 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/

README.md

@@ -0,0 +1,9 @@
+
+``fritzctl`` - Python Client Library for the AVM TR64 API
+=======================================================
+
+``fritzctl`` is a fully Object-Oriented Client Library designed to be flexible and future-compatible.
+
+You can install ``fritzctl`` by executing ``python setup.py install`` with the appropriate rights.
+
+Refer to the documentation located in ``/docs/_build/html/`` for more information and a getting started guide.

README.txt

@@ -0,0 +1,9 @@
+
+``fritzctl`` - Python Client Library for the AVM TR64 API
+=======================================================
+
+``fritzctl`` is a fully Object-Oriented Client Library designed to be flexible and future-compatible.
+
+You can install ``fritzctl`` by executing ``python setup.py install`` with the appropriate rights.
+
+Refer to the documentation located in ``/docs/_build/html/`` for more information and a getting started guide.

docs/Makefile

@@ -0,0 +1,192 @@
+# 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 coverage 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 "  applehelp  to make an Apple Help Book"
+	@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)"
+	@echo "  coverage   to run coverage check of 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."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/fritzctl.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/fritzctl.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/fritzctl"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/fritzctl"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/api/fritzctl.dynapi.rst

@@ -0,0 +1,7 @@
+
+``fritzctl.dynapi`` - Dynamic API Classes
+=========================================
+
+.. automodule:: fritzctl.dynapi
+   :members:
+   :synopsis: Dynamic API Classes

docs/api/fritzctl.rst

@@ -0,0 +1,21 @@
+
+``fritzctl`` - Python Client Library for the AVM TR64 API
+=========================================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   fritzctl.session
+   fritzctl.dynapi
+
+   ooapi/index
+
+Root Module
+-----------
+
+.. automodule:: fritzctl
+   :members:
+   :synopsis: Python Client Library for the AVM TR64 API

docs/api/fritzctl.session.rst

@@ -0,0 +1,7 @@
+
+``fritzctl.session`` - TR64 Session and Device Management
+=========================================================
+
+.. automodule:: fritzctl.session
+   :members:
+   :synopsis: TR64 Session and Device Management

docs/api/ooapi/avm_homeauto.rst

@@ -0,0 +1,7 @@
+
+``fritzctl.ooapi.avm_homeauto`` - Homeautomation OO Wrapper Classes
+===================================================================
+
+.. automodule:: fritzctl.ooapi.avm_homeauto
+   :members:
+   :synopsis: Homeautomation OO Wrapper Classes

docs/api/ooapi/avm_homeplug.rst

@@ -0,0 +1,7 @@
+
+``fritzctl.ooapi.avm_homeplug`` - Powerline Information OO Wrapper Classes
+==========================================================================
+
+.. automodule:: fritzctl.ooapi.avm_homeplug
+   :members:
+   :synopsis: Powerline Information OO Wrapper Classes

docs/api/ooapi/base.rst

@@ -0,0 +1,7 @@
+
+``fritzctl.ooapi.base`` - Base Object-Oriented API Class
+========================================================
+
+.. automodule:: fritzctl.ooapi.base
+   :members:
+   :synopsis: Base Object-Oriented API Class

docs/api/ooapi/general_deviceconfig.rst

@@ -0,0 +1,7 @@
+
+``fritzctl.ooapi.general_deviceconfig`` - Device Configuration OO Wrapper Classes
+=================================================================================
+
+.. automodule:: fritzctl.ooapi.general_deviceconfig
+   :members:
+   :synopsis: Device Configuration OO Wrapper Classes

docs/api/ooapi/general_deviceinfo.rst

@@ -0,0 +1,7 @@
+
+``fritzctl.ooapi.general_deviceinfo`` - Device Information OO Wrapper Classes
+=============================================================================
+
+.. automodule:: fritzctl.ooapi.general_deviceinfo
+   :members:
+   :synopsis: Device Information OO Wrapper Classes

docs/api/ooapi/general_hosts.rst

@@ -0,0 +1,7 @@
+
+``fritzctl.ooapi.general_hosts`` - General Host Information OO Wrapper Classes
+==============================================================================
+
+.. automodule:: fritzctl.ooapi.general_hosts
+   :members:
+   :synopsis: General Host Information OO Wrapper Classes

docs/api/ooapi/general_time.rst

@@ -0,0 +1,7 @@
+
+``fritzctl.ooapi.general_time`` - Time configuration OO Wrapper Classes
+=======================================================================
+
+.. automodule:: fritzctl.ooapi.general_time
+   :members:
+   :synopsis: Time configuration OO Wrapper Classes

docs/api/ooapi/index.rst

@@ -0,0 +1,22 @@
+
+``fritzctl.ooapi`` - Object-Oriented API Wrappers
+=================================================
+
+.. toctree::
+   :maxdepth: 1
+
+   base
+
+   avm_homeauto
+   avm_homeplug
+
+   general_time
+   general_deviceinfo
+   general_deviceconfig
+   general_hosts
+
+   net_wlan_multi
+
+.. automodule:: fritzctl.ooapi
+   :members:
+   :synopsis: Object-Oriented API Wrappers

docs/api/ooapi/net_wlan_multi.rst

@@ -0,0 +1,7 @@
+
+``fritzctl.ooapi.net_wlan_multi`` - WLAN Configuration OO Wrapper Classes
+=========================================================================
+
+.. automodule:: fritzctl.ooapi.net_wlan_multi
+   :members:
+   :synopsis: WLAN Configuration OO Wrapper Classes