merakicat 0.0.14__tar.gz

merakicat-0.0.14/.github/workflows/publish.yaml

@@ -0,0 +1,17 @@
+name: Publish to PyPI.org
+on:
+  release:
+    types: [published]
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - run: python3 -m pip install --upgrade build && python3 -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

merakicat-0.0.14/.gitignore

@@ -0,0 +1,139 @@
+# My own testing credentials
+src/mc_user_info.py
+
+# Miscellaneous files
+src/batch_helper_preview.json
+src/test.txt
+
+# App-created files and logs
+files/*.cfg
+files/*.pdf
+files/*.docx
+files/*.ab0
+files/*.ab1
+files/*.pd
+*.log
+
+# webexteamsbot
+webexteamsbot/
+
+# Dev Exclusions
+scratch*
+dev_botenv
+venv-*/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+src/__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.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
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+holdmecat.bbprojectd/Chat Worksheet.bbaiworksheet
+holdmecat.bbprojectd/ecoen.bbprojectsettings
+holdmecat.bbprojectd/project.bbprojectdata
+holdmecat.bbprojectd/Unix Worksheet.worksheet
+webexteamsbot/__pycache__/__init__.cpython-311.pyc
+webexteamsbot/__pycache__/models.cpython-311.pyc
+webexteamsbot/__pycache__/webexteamsbot.cpython-311.pyc
+*.pyc
+
+src/mc_user_info.py
+src/batch_helper_preview.json

merakicat-0.0.14/AUTHORS.rst

@@ -0,0 +1,15 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+Ed Coen <https://github.com/ecoen66>
+
+Based on Work by
+----------------
+* Fady Sharobeem <https://github.com/fadysharobeem>
+
+* Hank Preston <https://github.com/hpreston>
+* Josh Anderson <https://github.com/joshand>
+* Oleksii Borisenko <https://github.com/oborys>

merakicat-0.0.14/CONTRIBUTING.rst

@@ -0,0 +1,55 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/ecoen66/merakicat/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+webexteamsbot could always use more documentation, whether as part of the
+official webexteamsbot docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/ecoen66/merakicat/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)

merakicat-0.0.14/HISTORY.md

@@ -0,0 +1,66 @@
+# History
+
+## 0.0.14 (03-19-2024)
+
+  - Option added for check with drag and drop files in bot mode.
+  - Added missing timing in check report in bot mode.
+  - Still not yet released on PyPI.
+  
+## 0.0.13 (03-18-2024)
+
+  - Option added for detailed check report "with detail".
+  
+## 0.0.12 (03-15-2024)
+
+  - Option for PDF vs. DOCX reporting in checker.
+  - Layer 3 Interfaces (interface VLAN) supported.
+  - Static routes supported.
+  - Command added for "demo report".
+  
+## 0.0.11 (03-12-2024)
+
+  - New reporting in checker.
+  - Port-channel LACP is working and fast.
+  
+## 0.0.10 (03-08-2024)
+
+  - Using a single mc_pedia.
+  
+## 0.0.9 (03-07-2024)
+
+  - Using both config_pedia and check_pedia.
+  - Changed to ngrok API for bot functionality
+  
+## 0.0.8 (03-01-2024)
+
+  - Lots of comment blocks added.
+  
+## 0.0.7 (03-01-2024)
+
+  - Now using batch port updates to Meraki dashboard.
+  
+## 0.0.6 (03-01-2024)
+
+  - Some light refactoring of mc_translate module.
+  - More prep work for Uplink config.
+
+## 0.0.5 (02-29-2024)
+
+  - Added Catalyst NM module recognition and prep work for Uplink config.
+
+## 0.0.4 (02-28-2024)
+
+  - Removed external data fetch for list of unsupported features in prep for adding display of features that are semi-supported.
+  - Added command line help **python merakicat.py help**.
+
+## 0.0.3 (02-27-2024)
+
+  - Created command line option vs BOT.
+  - Just try **python merakicat.py convert host <host or ip address> to <meraki network>**.
+
+## 0.0.2 (02-26-2024)
+
+  - Not yet released on PyPI.
+
+## 0.0.1 (02-26-2024)
+

merakicat-0.0.14/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Cisco Systems, Inc. and its affiliates
+
+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.

merakicat-0.0.14/MANIFEST.in

@@ -0,0 +1,11 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.md
+include LICENSE
+include README.md
+
+# recursive-include tests *
+# recursive-exclude * __pycache__
+# recursive-exclude * *.py[co]
+
+# recursive-include Makefile *.jpg *.png *.gif

merakicat-0.0.14/Makefile

@@ -0,0 +1,88 @@
+.PHONY: clean clean-test clean-pyc clean-build docs help
+.DEFAULT_GOAL := help
+
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+
+try:
+	from urllib import pathname2url
+except:
+	from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+
+BROWSER := python -c "$$BROWSER_PYSCRIPT"
+
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+	rm -fr .pytest_cache
+
+lint: ## check style with flake8
+	flake8 merakicat tests
+
+test: ## run tests quickly with the default Python
+	python setup.py test
+
+test-all: ## run tests on every Python version with tox
+	tox
+
+coverage: ## check code coverage quickly with the default Python
+	coverage run --source merakicat setup.py test
+	coverage report -m
+	coverage html
+	$(BROWSER) htmlcov/index.html
+
+docs: ## generate Sphinx HTML documentation, including API docs
+	rm -f docs/merakicat.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ merakicat
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	$(BROWSER) docs/_build/html/index.html
+
+servedocs: docs ## compile the docs watching for changes
+	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+
+release: dist ## package and upload a release
+	twine upload dist/*
+
+dist: clean ## builds source and wheel package
+	python setup.py sdist
+	python setup.py bdist_wheel
+	ls -l dist
+
+install: clean ## install the package to the active Python's site-packages
+	python setup.py install

merakicat-0.0.14/PKG-INFO

@@ -0,0 +1,295 @@
+Metadata-Version: 2.1
+Name: merakicat
+Version: 0.0.14
+Summary: An app to check and translate Catalyst switch configs to Meraki.
+Home-page: https://github.com/ecoen66/merakicat
+Author: Ed Coen
+Author-email: ecoen@cisco.com
+License: MIT license
+Keywords: merakicat,catalyst,meraki,cisco,migration,webexteamsbot
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3 :: Only
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: webexteamsbot==0.1.4.2
+Requires-Dist: webexteamssdk==1.0.3
+Requires-Dist: Flask>=0.12.1
+Requires-Dist: netmiko==4.3.0
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: ciscoconfparse2==0.5
+Requires-Dist: meraki==1.42.0
+Requires-Dist: ngrok==1.1.0
+Requires-Dist: python-docx==1.1.0
+Requires-Dist: docx2pdf==0.1.8
+Requires-Dist: requests==2.31.0
+
+# merakicat
+
+This package makes migrating [Cisco](https://www.cisco.com) Catalyst switches to [Meraki](https:www.meraki.com) Dashboard much easier.
+
+Below is the list of configurations the tool can currently translate:
+
+switch:
+ - Hostname
+ - Spanning Tree RSTP
+ - Stack
+ - Static Routing
+
+port:
+ - Port Description
+ - Port Status
+ - Port Speed
+ - Port Duplex
+ - Port Type
+ - PoE Enabled
+ - Allowed VLANs
+ - Data VLAN
+ - Voice VLAN
+ - Layer 3 Interface
+ - STP RootGuard
+ - STP Loop Guard
+ - STP BPDU Guard
+ - Etherchannel LACP
+
+ 
+Once installed, you can print the entire index of the feature encyclopedia, or to print the index based on either supported and translatable items or both, enter:
+```
+cd src
+python mc_pedia [support] [translatable]
+```
+ 
+After the configuration is pushed to the Meraki dashboard, the app will present a summary of configured ports and those that were not configured.
+
+# Prerequisites
+
+If you don't already have a [Webex Teams](https://www.webex.com/products/teams/index.html) account, go ahead and [register](https://www.webex.com/pricing/free-trial.html) for one.  They are free.
+
+1. You'll need to start by adding your bot to the Webex Teams website.
+
+    [https://developer.webex.com/my-apps](https://developer.webex.com/my-apps)
+
+1. Click **Create a New App**
+
+    ![add-app](https://github.com/ecoen66/merakicat/raw/main/images/newapp.jpg)
+
+1. Click **Create a Bot**.
+
+    ![create-bot](https://github.com/ecoen66/merakicat/raw/main/images/createbot.jpg)
+
+2. Fill out all the details about your bot.  You'll need to set a name, username, icon (either upload one or choose a sample), and provide a description.
+
+    ![add-bot](https://github.com/ecoen66/merakicat/raw/main/images/newbot.jpg)
+
+3. Click **Add Bot**.
+
+1. On the Congratulations screen, make sure to copy the *Bot's Access Token*, you will need this in a second.
+
+    ![enter-details](https://github.com/ecoen66/merakicat/raw/main/images/botcongrats.jpg)
+
+# Installation
+
+> Python 3.11+ is recommended.
+
+ - Clone the github repository and install the requirements
+
+```
+git clone https://github.com/ecoen66/merakicat
+cd merakicat
+pip install -r requirements_dev.txt
+cd src
+python merakicat.py
+```
+
+# Usage
+
+ - The easiest way to use this module is to set a few environment variables
+
+    > Note: As an alternative, you may rename mc_user_sample.py to mc_user_info.py and edit the variables there.
+    > Although more convenient, it is less secure.
+
+    > Note: See [ngrok](#ngrok) for details on setting up an easy HTTP tunnel for webhooks callbacks.
+
+    ```
+    export NGROK_AUTHTOKEN=<your ngrok Authtoken>
+    export TEAMS_BOT_TOKEN=<your bot's token>
+    export TEAMS_BOT_EMAIL=<your bot's email>
+    export TEAMS_BOT_APP_NAME=<your bot's name>
+    export TEAMS_EMAILS=<a comma delimited list of email addresses the bot will respond to>
+    export IOS_USERNAME=<the ssh username for the Catalyst switches>
+    export IOS_PASSWORD=<the ssh password for the Catalyst switches>
+    export IOS_SECRET=<the CLI secret password for the Catalyst switches>
+    export IOS_PORT=<the ssh port number for the Catalyst switches - usually 22>
+    export MERAKI_API_KEY=<your meraki dashboard API key>
+    ```
+In addition to these settings, various debugs and a choice of PDF vs. DOCX report format can be enabled in the mc_user_info.py file.
+
+1. This app can be run either as a Webex Teams bot or as a standalone command line program.  To run it as a bot, just start it without any parameters:  
+
+    ```
+    cd src
+    python merakicat.py
+    ```
+    **Bot commands include the following:**
+
+    Check a Catalyst switch config for both translatable and possible Meraki features:
+    ```
+    check [host <FQDN or IP address> | file <filespec>] [with timing] [with detail]
+    ```
+    > Note: The check command can also be used with one or more attached files through drag and drop.
+    
+    Register a Catalyst switch to the Meraki Dashboard:
+    ```
+    register [host <FQDN or IP address>] [with timing]
+    ```
+    Claim Catalyst switches to a Meraki Network:
+    ```
+    claim [<Meraki serial numbers>] [to <Meraki network name>] [with timing]
+    ```
+    Translate a Catalyst switch config from a file or host to claimed Meraki serial numbers:
+    ```
+    translate [host <FQDN or IP address> | file <filespec>] [to <Meraki serial numbers>] [with timing]
+    ```
+    Migrate a Catalyst switch to a Meraki switch - register, claim & translate:
+    ```
+    migrate [host <FQDN or IP address>] [to <Meraki network name>] [with timing]
+    ```
+    Create a demo report for all features currently in the feature encyclopedia:
+    ```
+    demo report
+    ```
+
+
+1. To run it from the command line (or from a shell script), enter any of the following:
+
+    Check a Catalyst switch config for both translatable and possible Meraki features:
+    ```
+    check host <FQDN or IP address> | file <filespec> [with timing] [with detail]
+    ```
+    Register a Catalyst switch or stack to the Meraki Dashboard:
+    ```
+    register host <FQDN or IP address> [with timing]
+    ```
+    Claim Catalyst switches to a Meraki Network:
+    ```
+    claim <Meraki serial numbers> to <Meraki network name> [with timing]
+    ```
+    Translate a Catalyst switch or stack config from a file or host to claimed Meraki serial numbers:
+    ```
+    translate host <FQDN or IP address> | file <filespec> to <Meraki serial numbers> [with timing]
+    ```
+    Migrate a Catalyst switch to a Meraki switch - register, claim & translate:
+    ```
+    migrate host <FQDN or IP address> to <Meraki network name> [with timing]
+    ```
+    Create a demo report for all features currently in the feature encyclopedia:
+    ```
+    demo report
+    ```
+
+
+# ngrok for usage as a bot
+
+[ngrok](http://ngrok.com) will make it easy for you to interact with meraki cat as a bot.
+
+You can find account instructions here under `Sign up for free!`: [https://dashboard.ngrok.com/login](https://dashboard.ngrok.com/login)
+
+1. After you've created an `ngrok` account, you will need to get your Authtoken.  Click on `Your Authtoken` on the ngrok dashboard and copy it.
+
+
+1. You can now export it to the OS environment variables like this:
+
+    ```
+    export NGROK_AUTHTOKEN=<your ngrok Authtoken>
+    ```
+
+1. Now launch the bot!!
+
+    ```
+    python merakicat.py
+    ```
+
+# Credits
+**This project is _heavily_ based on the work of others:**
+
+`Catalyst_to_Meraki_Migration_Tool` by [Fady Sharobeem](https://github.com/fadysharobeem).
+
+`Catalyst_2_Meraki_Config_Checker` by [Fady Sharobeem](https://github.com/fadysharobeem).
+
+The bot functionality is based on the `webexteamsbot` project by [Hank Preston](https://github.com/hpreston).
+
+The initial packaging of the original `ciscosparkbot` project was done by [Kevin Corbin](https://github.com/kecorbin).
+
+
+
+# History
+
+## 0.0.14 (03-19-2024)
+
+  - Option added for check with drag and drop files in bot mode.
+  - Added missing timing in check report in bot mode.
+  - Still not yet released on PyPI.
+  
+## 0.0.13 (03-18-2024)
+
+  - Option added for detailed check report "with detail".
+  
+## 0.0.12 (03-15-2024)
+
+  - Option for PDF vs. DOCX reporting in checker.
+  - Layer 3 Interfaces (interface VLAN) supported.
+  - Static routes supported.
+  - Command added for "demo report".
+  
+## 0.0.11 (03-12-2024)
+
+  - New reporting in checker.
+  - Port-channel LACP is working and fast.
+  
+## 0.0.10 (03-08-2024)
+
+  - Using a single mc_pedia.
+  
+## 0.0.9 (03-07-2024)
+
+  - Using both config_pedia and check_pedia.
+  - Changed to ngrok API for bot functionality
+  
+## 0.0.8 (03-01-2024)
+
+  - Lots of comment blocks added.
+  
+## 0.0.7 (03-01-2024)
+
+  - Now using batch port updates to Meraki dashboard.
+  
+## 0.0.6 (03-01-2024)
+
+  - Some light refactoring of mc_translate module.
+  - More prep work for Uplink config.
+
+## 0.0.5 (02-29-2024)
+
+  - Added Catalyst NM module recognition and prep work for Uplink config.
+
+## 0.0.4 (02-28-2024)
+
+  - Removed external data fetch for list of unsupported features in prep for adding display of features that are semi-supported.
+  - Added command line help **python merakicat.py help**.
+
+## 0.0.3 (02-27-2024)
+
+  - Created command line option vs BOT.
+  - Just try **python merakicat.py convert host <host or ip address> to <meraki network>**.
+
+## 0.0.2 (02-26-2024)
+
+  - Not yet released on PyPI.
+
+## 0.0.1 (02-26-2024)
+