Add files via upload

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

conf.py

@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'fwOper'
+copyright = '2022, ALIASGAR [ALI]'
+author = 'ALIASGAR [ALI]'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.4'
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.autosummary',
+    'sphinx_rtd_theme',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- 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'
+
+# 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']

docs/_install.rst

@@ -0,0 +1,26 @@
+Installation & Requirements
+#############################
+
+Requirements
+==================
+
+	1. python >= 3.7
+
+-----------------
+
+Installation
+==================
+
+Install the fwOper package::
+
+    pip install --upgrade fwOper
+	
+
+
+---------------------------
+
+Inherited python packages
+====================================
+
+	* nettoolkit
+

docs/_preface.rst

@@ -0,0 +1,40 @@
+fwOper
+#######
+
+Welcome to fwOper's documentation!
+**********************************
+
+What is fwOper?
+================
+
+fwOper is an open python project to help working with various task for cisco Firewall configurations. Delta configuration changes can be generated based on the input 
+rule change request.
+
+
+
+.. caution::
+	It is solely users responsibility to review the configuration generated by the fwOper.
+
+	Owner of the package or package will not be liable in any manner for any mishap happen then after.
+
+
+.. warning::
+	Copyright (c) 2018 The Python Packaging Authority
+
+	Permission is hereby granted, free of charge, to any person obtaining a copy
+	of this software and associated documentation files (the "Software"), to deal
+	in the Software without restriction, including without limitation the rights
+	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	copies of the Software, and to permit persons to whom the Software is
+	furnished to do so, subject to the following conditions:
+
+	The above copyright notice and this permission notice shall be included in all
+	copies or substantial portions of the Software.
+
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+	SOFTWARE.

docs/_tech_doc.rst

@@ -0,0 +1,18 @@
+
+Technical documentation!
+#########################
+
+.. toctree::
+	:maxdepth: 2
+	:caption: Contents:
+	:numbered:
+
+	acl <t_doc/__acl>
+	acg <t_doc/__acg>
+	instances <t_doc/__instances>
+	route <t_doc/__route>
+	common <t_doc/__common>
+	entity <t_doc/__entity>
+	fwObj <t_doc/__fwObj>
+	member <t_doc/__member>
+	static <t_doc/__static>

docs/_user_doc.rst

@@ -0,0 +1,13 @@
+
+User documentation!
+########################
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   :numbered:
+
+   Access-Lists <u_doc/_acl_exec>
+   Object-Groups <u_doc/_acg_exec>
+   IP Routes <u_doc/_routes_exec>
+   Execution Sample <u_doc/_fwOper_exec_sample>

docs/t_doc/__acg.rst

@@ -0,0 +1,10 @@
+
+acg
+===========
+
+
+.. automodule:: fwOper.acg
+	:members:
+	:undoc-members:
+	:show-inheritance:
+

docs/t_doc/__acl.rst

@@ -0,0 +1,10 @@
+
+acl
+===========
+
+
+.. automodule:: fwOper.acl
+	:members:
+	:undoc-members:
+	:show-inheritance:
+

docs/t_doc/__common.rst

@@ -0,0 +1,9 @@
+
+common
+===========
+
+.. automodule:: fwOper.common
+	:members:
+	:undoc-members:
+	:show-inheritance:
+

docs/t_doc/__entity.rst

@@ -0,0 +1,10 @@
+
+entity
+===========
+
+
+.. automodule:: fwOper.entity
+	:members:
+	:undoc-members:
+	:show-inheritance:
+

docs/t_doc/__fwObj.rst

@@ -0,0 +1,10 @@
+
+fwObj
+===========
+
+
+.. automodule:: fwOper.fwObj
+	:members:
+	:undoc-members:
+	:show-inheritance:
+

docs/t_doc/__instances.rst

@@ -0,0 +1,10 @@
+
+instances
+===========
+
+
+.. automodule:: fwOper.instances
+	:members:
+	:undoc-members:
+	:show-inheritance:
+

docs/t_doc/__member.rst

@@ -0,0 +1,10 @@
+
+member
+===========
+
+
+.. automodule:: fwOper.member
+	:members:
+	:undoc-members:
+	:show-inheritance:
+

docs/t_doc/__route.rst

@@ -0,0 +1,10 @@
+
+route
+===========
+
+
+.. automodule:: fwOper.route
+	:members:
+	:undoc-members:
+	:show-inheritance:
+

docs/t_doc/__static.rst

@@ -0,0 +1,10 @@
+
+static
+===========
+
+
+.. automodule:: fwOper.static
+	:members:
+	:undoc-members:
+	:show-inheritance:
+