[Python-modules-commits] [pyeapi] 01/06: Imported Upstream version 0.6.1
Vincent Bernat
bernat at moszumanska.debian.org
Fri Jun 3 19:13:44 UTC 2016
This is an automated email from the git hooks/post-receive script.
bernat pushed a commit to branch master
in repository pyeapi.
commit 4f185fa24c738f17a79431a6af0cfd5a7c0c7e9a
Author: Vincent Bernat <bernat at debian.org>
Date: Fri Jun 3 20:51:51 2016 +0200
Imported Upstream version 0.6.1
---
.coveragerc | 29 +
CHANGELOG.md | 7 +
LICENSE | 27 +
MANIFEST.in | 24 +
Makefile | 70 ++
PKG-INFO | 38 +
README.md | 75 ++
VERSION | 1 +
dev-requirements.txt | 16 +
docs/Makefile | 187 ++++
docs/conf.py | 342 ++++++
docs/configfile.rst | 195 ++++
docs/contribute.rst | 43 +
docs/description.rst | 19 +
docs/generate_modules.py | 96 ++
docs/index.rst | 44 +
docs/install.rst | 144 +++
docs/license.rst | 29 +
docs/modules.rst | 8 +
docs/quickstart.rst | 115 ++
docs/release-notes-0.1.0.rst | 12 +
docs/release-notes-0.1.1.rst | 12 +
docs/release-notes-0.2.0.rst | 13 +
docs/release-notes-0.2.1.rst | 7 +
docs/release-notes-0.2.2.rst | 7 +
docs/release-notes-0.2.3.rst | 7 +
docs/release-notes-0.2.4.rst | 7 +
docs/release-notes-0.3.0.rst | 13 +
docs/release-notes-0.3.1.rst | 9 +
docs/release-notes-0.3.2.rst | 7 +
docs/release-notes-0.3.3.rst | 9 +
docs/release-notes-0.4.0.rst | 53 +
docs/release-notes-0.5.0.rst | 45 +
docs/release-notes-0.6.0.rst | 72 ++
docs/release-notes-0.6.1.rst | 20 +
docs/release-notes.rst | 23 +
docs/requirements.rst | 11 +
docs/support.rst | 33 +
examples/get_config.py | 23 +
examples/nodes.conf | 10 +
examples/simple.py | 10 +
examples/sysmac.py | 10 +
examples/vlans_api.py | 35 +
pyeapi.egg-info/PKG-INFO | 38 +
pyeapi.egg-info/SOURCES.txt | 127 +++
pyeapi.egg-info/dependency_links.txt | 1 +
pyeapi.egg-info/requires.txt | 11 +
pyeapi.egg-info/top_level.txt | 1 +
pyeapi/__init__.py | 38 +
pyeapi/api/__init__.py | 34 +
pyeapi/api/abstract.py | 220 ++++
pyeapi/api/acl.py | 156 +++
pyeapi/api/bgp.py | 330 ++++++
pyeapi/api/interfaces.py | 939 ++++++++++++++++
pyeapi/api/ipinterfaces.py | 260 +++++
pyeapi/api/mlag.py | 302 +++++
pyeapi/api/ntp.py | 196 ++++
pyeapi/api/routemaps.py | 357 ++++++
pyeapi/api/spanningtree.py | 37 +
pyeapi/api/staticroute.py | 384 +++++++
pyeapi/api/stp.py | 367 +++++++
pyeapi/api/switchports.py | 417 +++++++
pyeapi/api/system.py | 186 ++++
pyeapi/api/users.py | 306 ++++++
pyeapi/api/varp.py | 210 ++++
pyeapi/api/vlans.py | 354 ++++++
pyeapi/api/vrrp.py | 1401 ++++++++++++++++++++++++
pyeapi/client.py | 776 +++++++++++++
pyeapi/eapilib.py | 533 +++++++++
pyeapi/utils.py | 245 +++++
requirements.txt | 1 +
setup.cfg | 5 +
setup.py | 91 ++
test/fixtures/dut.conf | 5 +
test/fixtures/eapi.conf | 15 +
test/fixtures/eapi.conf.yaml | 6 +
test/fixtures/empty.conf | 0
test/fixtures/env_path.conf | 5 +
test/fixtures/ipinterfaces.json | 81 ++
test/fixtures/nohost.conf | 2 +
test/fixtures/running_config.bgp | 19 +
test/fixtures/running_config.portchannel | 384 +++++++
test/fixtures/running_config.routemaps | 35 +
test/fixtures/running_config.text | 1752 ++++++++++++++++++++++++++++++
test/fixtures/running_config.varp | 17 +
test/fixtures/running_config.varp_null | 19 +
test/fixtures/running_config.vrrp | 533 +++++++++
test/fixtures/running_config.vxlan | 49 +
test/fixtures/show_interfaces.json | 497 +++++++++
test/fixtures/show_interfaces.text | 1 +
test/fixtures/show_portchannel.json | 8 +
test/fixtures/show_version.json | 13 +
test/fixtures/show_version.text | 1 +
test/fixtures/vxlan.json | 24 +
test/lib/systestlib.py | 77 ++
test/lib/testlib.py | 117 ++
test/system/test_api_acl.py | 145 +++
test/system/test_api_interfaces.py | 484 +++++++++
test/system/test_api_ipinterfaces.py | 135 +++
test/system/test_api_mlag.py | 248 +++++
test/system/test_api_ntp.py | 157 +++
test/system/test_api_routemaps.py | 277 +++++
test/system/test_api_staticroute.py | 291 +++++
test/system/test_api_stp.py | 144 +++
test/system/test_api_switchports.py | 136 +++
test/system/test_api_system.py | 230 ++++
test/system/test_api_users.py | 181 +++
test/system/test_api_varp.py | 236 ++++
test/system/test_api_vlans.py | 196 ++++
test/system/test_api_vrrp.py | 499 +++++++++
test/system/test_client.py | 194 ++++
test/unit/test_api_acl.py | 113 ++
test/unit/test_api_bgp.py | 405 +++++++
test/unit/test_api_interfaces.py | 440 ++++++++
test/unit/test_api_ipinterfaces.py | 138 +++
test/unit/test_api_mlag.py | 154 +++
test/unit/test_api_ntp.py | 118 ++
test/unit/test_api_routemaps.py | 158 +++
test/unit/test_api_staticroute.py | 304 ++++++
test/unit/test_api_stp.py | 188 ++++
test/unit/test_api_switchports.py | 205 ++++
test/unit/test_api_system.py | 102 ++
test/unit/test_api_users.py | 151 +++
test/unit/test_api_varp.py | 150 +++
test/unit/test_api_vlans.py | 154 +++
test/unit/test_api_vrrp.py | 809 ++++++++++++++
test/unit/test_client.py | 331 ++++++
test/unit/test_eapilib.py | 140 +++
test/unit/test_utils.py | 79 ++
129 files changed, 21632 insertions(+)
diff --git a/.coveragerc b/.coveragerc
new file mode 100644
index 0000000..8726c6c
--- /dev/null
+++ b/.coveragerc
@@ -0,0 +1,29 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+omit = *mock*
+ *test*
+ *netaddr*
+
+[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__.:
+
+ignore_errors = True
+
+[html]
+directory = coverage_html_report
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..84fcc30
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,7 @@
+Python Client for eAPI
+======================
+
+Full [release notes] [rns] hosted at readthedocs
+
+
+[rns]: http://pyeapi.readthedocs.org/en/master/release-notes.html
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..60a2b6a
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) 2014, Arista Networks EOS+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+* 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.
+
+* Neither the name of the Arista nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+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 HOLDER 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.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..df2bb8e
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,24 @@
+include *.md
+include *.txt
+include .coveragerc
+include LICENSE
+include Makefile
+include VERSION
+recursive-include examples *.conf
+recursive-include examples *.py
+recursive-include test *.conf
+recursive-include test *.json
+recursive-include test *.portchannel
+recursive-include test *.py
+recursive-include test *.text
+recursive-include test *.vxlan
+recursive-include test *.bgp
+recursive-include test *.routemaps
+recursive-include test *.varp
+recursive-include test *.varp_null
+recursive-include test *.vrrp
+recursive-include test *.yaml
+recursive-include docs description.rst
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs Makefile
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..9829dcb
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,70 @@
+#!/usr/bin/make
+# WARN: gmake syntax
+########################################################
+# Makefile for pyeapi
+#
+# useful targets:
+# make sdist -- build python source distribution
+# make pep8 -- pep8 checks
+# make pyflakes -- pyflakes checks
+# make flake8 -- flake8 checks
+# make check -- manifest checks
+# make tests -- run all of the tests
+# make unittest -- runs the unit tests
+# make systest -- runs the system tests
+# make clean -- clean distutils
+#
+########################################################
+# variable section
+
+NAME = "pyeapi"
+
+PYTHON=python
+COVERAGE=coverage
+SITELIB = $(shell $(PYTHON) -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")
+
+VERSION := $(shell cat VERSION)
+
+########################################################
+
+all: clean check pep8 flake8 tests
+
+pep8:
+ -pep8 -r --ignore=E402,E731,E501,E221,W291,W391,E302,E251,E203,W293,E231,E303,E201,E225,E261,E241 pyeapi/ test/
+
+pyflakes:
+ pyflakes pyeapi/ test/
+
+flake8:
+ flake8 --ignore=E302,E303,E402,E731,W391 --exit-zero pyeapi/
+ flake8 --ignore=E302,E303,E402,E731,W391,N802 --max-line-length=100 test/
+
+check:
+ check-manifest
+
+clean:
+ @echo "Cleaning up distutils stuff"
+ rm -rf build
+ rm -rf dist
+ rm -rf MANIFEST
+ rm -rf *.egg-info
+ @echo "Cleaning up byte compiled python stuff"
+ find . -type f -regex ".*\.py[co]$$" -delete
+ @echo "Cleaning up doc builds"
+ rm -rf docs/_build
+ rm -rf docs/api_modules
+ rm -rf docs/client_modules
+
+sdist: clean
+ $(PYTHON) setup.py sdist
+
+tests: unittest systest
+
+unittest: clean
+ $(COVERAGE) run -m unittest discover test/unit -v
+
+systest: clean
+ $(COVERAGE) run -m unittest discover test/system -v
+
+coverage_report:
+ $(COVERAGE) report -m
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..aa201b0
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,38 @@
+Metadata-Version: 1.1
+Name: pyeapi
+Version: 0.6.1
+Summary: Python Client for eAPI
+Home-page: https://github.com/arista-eosplus/pyeapi
+Author: Arista EOS+ CS
+Author-email: eosplus-dev at arista.com
+License: BSD-3
+Description: The Python Client for eAPI
+ ==========================
+
+ The Python Client for eAPI (pyeapi) is a native Python library wrapper around
+ Arista EOS eAPI. It provides a set of Python language bindings for configuring
+ Arista EOS nodes.
+
+ The Python library can be used to communicate with EOS either locally
+ (on-box) or remotely (off-box). It uses a standard INI-style configuration file
+ to specify one or more nodes and connection profiles.
+
+ The pyeapi library also provides an API layer for building native Python
+ objects to interact with the destination nodes. The API layer is a convenient
+ implementation for working with the EOS configuration and is extensible for
+ developing custom implementations.
+
+ This library is freely provided to the open source community for building
+ robust applications using Arista EOS. Support is provided as best effort
+ through Github issues.
+
+Keywords: networking arista eos eapi
+Platform: UNKNOWN
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: System Administrators
+Classifier: Topic :: System :: Networking
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7d1e831
--- /dev/null
+++ b/README.md
@@ -0,0 +1,75 @@
+# Arista eAPI Python Library
+
+[](https://travis-ci.org/arista-eosplus/pyeapi) [](https://coveralls.io/r/arista-eosplus/pyeapi?branch=develop) [](http://readthedocs.org/docs/pyeapi/en/latest/?badge=latest)
+
+The Python library for Arista's eAPI command API implementation provides a
+client API work using eAPI and communicating with EOS nodes. The Python
+library can be used to communicate with EOS either locally (on-box) or remotely
+(off-box). It uses a standard INI-style configuration file to specify one or
+more nodes and connection properties.
+
+The pyeapi library also provides an API layer for building native Python
+objects to interact with the destination nodes. The API layer is a convenient
+implementation for working with the EOS configuration and is extensible for
+developing custom implementations.
+
+This library is freely provided to the open source community for building
+robust applications using Arista EOS. Support is provided as best effort
+through Github issues.
+
+## Documentation
+
+* [Quickstart] [quickstart]
+* [Installation] [install]
+* [Modules] [modules]
+* [Release Notes] [rns]
+* [Contribute] [contribute]
+
+### Building Local Documentation
+
+If you cannot access readthedocs.org you have the option of building the
+documentation locally.
+
+1. ``pip install -r dev-requirements.txt``
+2. ``cd docs``
+3. ``make html``
+4. ``open _build/html/index.html``
+
+# License
+
+Copyright (c) 2015, Arista Networks EOS+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+* 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.
+
+* Neither the name of the Arista nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+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 HOLDER 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.
+
+
+[pyeapi]: https://github.com/arista-eosplus/pyeapi
+[quickstart]: http://pyeapi.readthedocs.org/en/master/quickstart.html
+[install]: http://pyeapi.readthedocs.org/en/master/install.html
+[contribute]: http://pyeapi.readthedocs.org/en/master/contribute.html
+[modules]: http://pyeapi.readthedocs.org/en/master/modules.html
+[support]: http://pyeapi.readthedocs.org/en/master/support.html
+[rns]: http://pyeapi.readthedocs.org/en/master/release-notes.html
diff --git a/VERSION b/VERSION
new file mode 100644
index 0000000..ee6cdce
--- /dev/null
+++ b/VERSION
@@ -0,0 +1 @@
+0.6.1
diff --git a/dev-requirements.txt b/dev-requirements.txt
new file mode 100644
index 0000000..aa05d1f
--- /dev/null
+++ b/dev-requirements.txt
@@ -0,0 +1,16 @@
+netaddr
+mock
+coveralls
+twine
+check-manifest
+pep8
+pyflakes
+coverage
+sphinx
+sphinxcontrib-napoleon
+flake8
+flake8-print
+flake8-debugger
+pep8-naming
+
+
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..da55edf
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,187 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+APIDIR = api_modules
+CLIENTDIR = client_modules
+CWD := $(shell pwd)
+
+# 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)/*
+ rm -rf $(CLIENTDIR)/*
+ rm -rf $(APIDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+modules:
+ python $(CWD)/generate_modules.py
+
+docs: clean modules 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/PythonClientforeAPI.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PythonClientforeAPI.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/PythonClientforeAPI"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PythonClientforeAPI"
+ @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."
+
+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."
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100755
index 0000000..39f076b
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,342 @@
+# -*- coding: utf-8 -*-
+#
+# Python Client for eAPI documentation build configuration file, created by
+# sphinx-quickstart on Sat Mar 28 22:43:11 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+import re
+import sphinx_rtd_theme
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, '../pyeapi')
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.viewcode',
+ 'sphinx.ext.doctest',
+ 'sphinxcontrib.napoleon'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Python Client for eAPI'
+copyright = u'2015, Arista EOS+ CS'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+release = open('../VERSION').read().split()[0].strip()
+# Assume PEP 440 version strings
+p = re.compile(r'(\d+!)?((\d+)(.\d+)*(.\d+)*)(.?[a|b|rc]\d*)?(.post\d*)?(.dev\d*)?', re.IGNORECASE)
+vers = p.search(release)
+
+if vers:
+ version = vers.group(2)
+else:
+ version = 'develop'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PythonClientforeAPIdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ ('index', 'PythonClientforeAPI.tex', u'Python Client for eAPI Documentation',
+ u'Arista EOS+ CS', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'pythonclientforeapi', u'Python Client for eAPI Documentation',
+ [u'Arista EOS+ CS'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'PythonClientforeAPI', u'Python Client for eAPI Documentation',
+ u'Arista EOS+ CS', 'PythonClientforeAPI', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'Python Client for eAPI'
+epub_author = u'Arista EOS+ CS'
+epub_publisher = u'Arista EOS+ CS'
+epub_copyright = u'2015, Arista EOS+ CS'
+
+# The basename for the epub file. It defaults to the project name.
+#epub_basename = u'Python Client for eAPI'
+
+# The HTML theme for the epub output. Since the default themes are not optimized
+# for small screen space, using the same theme for HTML and epub output is
+# usually not wise. This defaults to 'epub', a theme designed to save visual
+# space.
+#epub_theme = 'epub'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#epub_guide = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# The depth of the table of contents in toc.ncx.
... 21541 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/pyeapi.git
More information about the Python-modules-commits
mailing list