diff --git a/CHANGES.txt b/CHANGES.txt index adf34f1..de5e1e5 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -1,4 +1,10 @@ +Revision 0.6.1, released 07-01-2018 +----------------------------------- + +- The pysnmp-apps project renamed into a hopefully more meaningful + snmpclitools + Revision 0.5.3, released 06-01-2018 ----------------------------------- @@ -66,7 +72,7 @@ Revision 0.3.4, released 05-10-2013 Revision 0.3.3, released 30-01-2013 ----------------------------------- -- Tools will report pysnmp-apps package version along with pysnmp version +- Tools will report snmpclitools package version along with pysnmp version being used. - Package meta-information updated. - Package version is now in __init__.__version__ @@ -213,4 +219,4 @@ Revision 0.0.1 - PySNMP-based applications split off the pysnmp package and re-released on their own - The command line interface to SNMP tools previously shipped along with PySNMP - not reworked for a more consistent design and re-released within pysnmp-apps. + not reworked for a more consistent design and re-released within snmpclitools. diff --git a/README.md b/README.md index 0c844fc..de205ce 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -Pure-Python SNMP management tools ---------------------------------- +Command-line SNMP tools +----------------------- -[![PyPI](https://img.shields.io/pypi/v/pysnmp-apps.svg?maxAge=2592000)](https://pypi.python.org/pypi/pysnmp-apps) -[![Python Versions](https://img.shields.io/pypi/pyversions/pysnmp-apps.svg)](https://pypi.python.org/pypi/pysnmp-apps/) -[![Build status](https://travis-ci.org/etingof/pysnmp-apps.svg?branch=master)](https://secure.travis-ci.org/etingof/pysnmp-apps) -[![GitHub license](https://img.shields.io/badge/license-BSD-blue.svg)](https://raw.githubusercontent.com/etingof/pysnmp-apps/master/LICENSE.txt) +[![PyPI](https://img.shields.io/pypi/v/snmpclitools.svg?maxAge=2592000)](https://pypi.python.org/pypi/snmpclitools) +[![Python Versions](https://img.shields.io/pypi/pyversions/snmpclitools.svg)](https://pypi.python.org/pypi/snmpclitools/) +[![Build status](https://travis-ci.org/etingof/snmpclitools.svg?branch=master)](https://secure.travis-ci.org/etingof/snmpclitools) +[![GitHub license](https://img.shields.io/badge/license-BSD-blue.svg)](https://raw.githubusercontent.com/etingof/snmpclitools/master/LICENSE.txt) -Here is a set of SNMP applications written on top of -[pysnmp](http://snmplabs.com/pysnmp/) library. Some of these tools mimic -their famous [Net-SNMP](http://sourceforge.net/projects/net-snmp/) -counterparts, while the rest are designed to ease integration with -other Python applications. +This is a collection of command-line SNMP tools written in pure-Python. +The tools mimic their famous [Net-SNMP](http://sourceforge.net/projects/net-snmp/) +counterparts. + +In the past this project was known as *pysnmp-apps*. Features -------- @@ -28,17 +28,17 @@ Features Download -------- -The pysnmp-apps package is distributed under terms and conditions of 2-clause -BSD [license](http://snmplabs.com/pysnmp/license.html). Source code is freely -available as a Github [repo](https://github.com/etingof/pysnmp-apps). +The snmpclitools package is distributed under terms and conditions of 2-clause +BSD [license](http://snmplabs.com/snmpclitools/license.html). Source code is freely +available as a Github [repo](https://github.com/etingof/snmpclitools). Installation ------------ -Download pysnmp-apps from [PyPI](https://pypi.python.org/pypi/pysnmp-apps) or just run: +Download snmpclitools from [PyPI](https://pypi.python.org/pypi/snmpclitools) or just run: ```bash -$ pip install pysnmp-apps +$ pip install snmpclitools ``` How to use the tools @@ -66,13 +66,13 @@ notWritable(17) For more information, please, run any of these tools with --help option. You can play with different security protocols against the publicly available SNMP -agent like [this one @snmplabs.com](http://snmplabs.com/snmpsim/public-snmp-agent-simulator.html>). +agent like [this one @snmplabs.com](http://snmplabs.com/snmpsim/public-snmp-agent-simulator.html). Getting help ------------ -If something does not work as expected, try browsing PySNMP -[mailing list archives](http://sourceforge.net/mail/?group_id=14735) or post +If something does not work as expected, please open up a +[GitHub issue](https://github.com/etingof/snmpclitools/issues/new) or post your question [to Stack Overflow](http://stackoverflow.com/questions/ask). Feedback and collaboration diff --git a/docs/source/conf.py b/docs/source/conf.py index ab8b433..e99bacc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -100,7 +100,7 @@ 'description': '

Brewing free software for the greater good

', 'show_powered_by': False, 'github_user': 'etingof', - 'github_repo': 'pysnmp-apps', + 'github_repo': 'snmpclitools', 'fixed_sidebar': True, } diff --git a/docs/source/contents.rst b/docs/source/contents.rst index c32fd8f..13f3bab 100644 --- a/docs/source/contents.rst +++ b/docs/source/contents.rst @@ -19,14 +19,14 @@ of computing platforms and ease introducing new SNMP features by leveraging the high-level programming language. These SNMP tools are free and open-source. Source code is hosted in -a `GitHub repo `_ and +a `GitHub repo `_ and distributed under 2-clause BSD-style license. Quick start ----------- If you understand SNMP and have some experience with the Net-SNMP tool set, -you do not need to learn much. Just install *pysnmp-apps* and run the +you do not need to learn much. Just install *snmpclitools* and run the *.py*-suffixed version of the SNMP tool you want. .. code-block:: bash @@ -103,7 +103,7 @@ Best way is usually to .. code-block:: bash - # pip install pysnmp-apps + # pip install snmpclitools If that does not work for you for some reason, you might need to read the following page. @@ -133,5 +133,5 @@ Contact ------- In case of questions or issues using these SNMP tools, please open up an -`issue `_ at GitHub. +`issue `_ at GitHub. Or just fix it and send us a pull request. ;-) diff --git a/docs/source/download.rst b/docs/source/download.rst index 2a4b365..1d6a457 100644 --- a/docs/source/download.rst +++ b/docs/source/download.rst @@ -7,8 +7,8 @@ Getting SNMP tools The SNMP tools are provided under terms and conditions of BSD-style license, and can be freely downloaded from -`PyPI `_ or -GitHub (`master branch `_). +`PyPI `_ or +GitHub (`master branch `_). The best way to obtain SNMP tools and dependencies is to *pip install* them all into a Python virtual environment: @@ -17,13 +17,13 @@ them all into a Python virtual environment: $ python3 -m venv venv3 $ . venv3/bin/activate - $ pip install pysnmp-apps + $ pip install snmpclitools or .. code-block:: bash - $ easy_install pysnmp-apps + $ easy_install snmpclitools In case you do not have the *easy_install* command on your system but still would like to use the on-line package installation method, please install @@ -63,7 +63,7 @@ The installation procedure for all the above packages is as follows # cd .. # rm -rf package-X.X.X -In case of any issues, please open a `GitHub issue `_ so +In case of any issues, please open a `GitHub issue `_ so we could try to help out. diff --git a/scripts/snmpbulkwalk.py b/scripts/snmpbulkwalk.py index fb8450d..97f88c2 100755 --- a/scripts/snmpbulkwalk.py +++ b/scripts/snmpbulkwalk.py @@ -1,15 +1,15 @@ #!/usr/bin/env python -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # # GETBULK command generator # import sys import time import traceback -from pysnmp_apps.cli import main, msgmod, secmod, target, pdu, mibview, base +from snmpclitools.cli import main, msgmod, secmod, target, pdu, mibview, base from pysnmp.entity import engine from pysnmp.entity.rfc3413 import cmdgen from pysnmp.proto import rfc1902 diff --git a/scripts/snmpget.py b/scripts/snmpget.py index 3c3995d..bf49d45 100755 --- a/scripts/snmpget.py +++ b/scripts/snmpget.py @@ -1,15 +1,15 @@ #!/usr/bin/env python # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # # GET command generator # import sys import traceback -from pysnmp_apps.cli import main, msgmod, secmod, target, pdu, mibview, base +from snmpclitools.cli import main, msgmod, secmod, target, pdu, mibview, base from pysnmp.entity import engine from pysnmp.entity.rfc3413 import cmdgen from pysnmp import error diff --git a/scripts/snmpset.py b/scripts/snmpset.py index 31c963e..7047974 100755 --- a/scripts/snmpset.py +++ b/scripts/snmpset.py @@ -1,15 +1,15 @@ #!/usr/bin/env python # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # # SET command generator # import sys import traceback -from pysnmp_apps.cli import main, msgmod, secmod, target, pdu, mibview, base +from snmpclitools.cli import main, msgmod, secmod, target, pdu, mibview, base from pysnmp.entity import engine from pysnmp.entity.rfc3413 import cmdgen from pysnmp import error diff --git a/scripts/snmptranslate.py b/scripts/snmptranslate.py index 3396796..80eef18 100755 --- a/scripts/snmptranslate.py +++ b/scripts/snmptranslate.py @@ -1,16 +1,16 @@ #!/usr/bin/env python # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # # Command-line MIB browser # import sys import traceback from pysnmp.entity import engine -from pysnmp_apps.cli import main, pdu, mibview, base +from snmpclitools.cli import main, pdu, mibview, base from pysnmp.smi.error import NoSuchObjectError from pysnmp import error from pyasn1.type import univ diff --git a/scripts/snmptrap.py b/scripts/snmptrap.py index fdcb601..d2d9907 100755 --- a/scripts/snmptrap.py +++ b/scripts/snmptrap.py @@ -1,16 +1,16 @@ #!/usr/bin/env python # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # # Notificaton Originator # import sys import socket import traceback -from pysnmp_apps.cli import main, msgmod, secmod, target, pdu, mibview, base +from snmpclitools.cli import main, msgmod, secmod, target, pdu, mibview, base from pysnmp.entity import engine, config from pysnmp.entity.rfc3413 import ntforg from pysnmp.proto.proxy import rfc2576 diff --git a/scripts/snmpwalk.py b/scripts/snmpwalk.py index 43d7ac6..f1cbf61 100755 --- a/scripts/snmpwalk.py +++ b/scripts/snmpwalk.py @@ -1,16 +1,16 @@ #!/usr/bin/env python # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # # GETNEXT command generator # import sys import time import traceback -from pysnmp_apps.cli import main, msgmod, secmod, target, pdu, mibview, base +from snmpclitools.cli import main, msgmod, secmod, target, pdu, mibview, base from pysnmp.entity import engine from pysnmp.entity.rfc3413 import cmdgen from pysnmp.proto import rfc1902 diff --git a/setup.py b/setup.py index 21065ce..27065fb 100644 --- a/setup.py +++ b/setup.py @@ -1,9 +1,9 @@ #!/usr/bin/env python # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # """SNMP command-line tools @@ -80,18 +80,18 @@ def howto_install_setuptools(): params.update( { - 'name': 'pysnmp-apps', - 'version': open('pysnmp_apps/__init__.py').read().split('\'')[1], + 'name': 'snmpclitools', + 'version': open('snmpclitools/__init__.py').read().split('\'')[1], 'description': doclines[0], 'long_description': ' '.join(doclines[1:]), 'maintainer': 'Ilya Etingof ', 'author': 'Ilya Etingof', 'author_email': 'etingof@gmail.com', - 'url': 'https://github.com/etingof/pysnmp-apps', + 'url': 'https://github.com/etingof/snmpclitools', 'classifiers': [x for x in classifiers.split('\n') if x], 'platforms': ['any'], 'license': 'BSD', - 'packages': ['pysnmp_apps', 'pysnmp_apps.cli'], + 'packages': ['snmpclitools', 'snmpclitools.cli'], 'scripts': ['scripts/snmpget.py', 'scripts/snmpset.py', 'scripts/snmpwalk.py', diff --git a/pysnmp_apps/__init__.py b/snmpclitools/__init__.py similarity index 66% rename from pysnmp_apps/__init__.py rename to snmpclitools/__init__.py index f2eb3d4..5e0bbc1 100644 --- a/pysnmp_apps/__init__.py +++ b/snmpclitools/__init__.py @@ -1,2 +1,2 @@ # http://www.python.org/dev/peps/pep-0396/ -__version__ = '0.5.3' +__version__ = '0.6.1' diff --git a/pysnmp_apps/cli/__init__.py b/snmpclitools/cli/__init__.py similarity index 100% rename from pysnmp_apps/cli/__init__.py rename to snmpclitools/cli/__init__.py diff --git a/pysnmp_apps/cli/base.py b/snmpclitools/cli/base.py similarity index 96% rename from pysnmp_apps/cli/base.py rename to snmpclitools/cli/base.py index 8b31038..9084da2 100644 --- a/pysnmp_apps/cli/base.py +++ b/snmpclitools/cli/base.py @@ -1,11 +1,11 @@ # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # import sys -from pysnmp_apps.cli import spark +from snmpclitools.cli import spark # AST diff --git a/pysnmp_apps/cli/main.py b/snmpclitools/cli/main.py similarity index 94% rename from pysnmp_apps/cli/main.py rename to snmpclitools/cli/main.py index 6b4885f..1e22cdc 100644 --- a/pysnmp_apps/cli/main.py +++ b/snmpclitools/cli/main.py @@ -1,14 +1,14 @@ # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # import sys from pysnmp.smi import view -from pysnmp_apps.cli import base +from snmpclitools.cli import base from pysnmp import error -from pysnmp_apps import __version__ as pysnmpAppsVersion +from snmpclitools import __version__ as pysnmpAppsVersion try: from pysnmp import __version__ as pysnmpVersion diff --git a/pysnmp_apps/cli/mibview.py b/snmpclitools/cli/mibview.py similarity index 99% rename from pysnmp_apps/cli/mibview.py rename to snmpclitools/cli/mibview.py index 1eba949..3e63680 100644 --- a/pysnmp_apps/cli/mibview.py +++ b/snmpclitools/cli/mibview.py @@ -1,15 +1,15 @@ # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # # C/L interface to MIB variables. Mimics Net-SNMP CLI. # import os from pyasn1.type import univ from pyasn1.type import namedval -from pysnmp_apps.cli import base +from snmpclitools.cli import base from pysnmp.proto import rfc1902 from pysnmp.smi import builder, compiler from pysnmp import error diff --git a/pysnmp_apps/cli/msgmod.py b/snmpclitools/cli/msgmod.py similarity index 90% rename from pysnmp_apps/cli/msgmod.py rename to snmpclitools/cli/msgmod.py index 3ce8a0e..c036292 100644 --- a/pysnmp_apps/cli/msgmod.py +++ b/snmpclitools/cli/msgmod.py @@ -1,10 +1,10 @@ # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # -from pysnmp_apps.cli import base +from snmpclitools.cli import base from pysnmp import error diff --git a/pysnmp_apps/cli/pdu.py b/snmpclitools/cli/pdu.py similarity index 98% rename from pysnmp_apps/cli/pdu.py rename to snmpclitools/cli/pdu.py index 23b7118..00541b2 100644 --- a/pysnmp_apps/cli/pdu.py +++ b/snmpclitools/cli/pdu.py @@ -1,15 +1,15 @@ # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # import sys from pyasn1.type import univ from pyasn1.error import PyAsn1Error from pysnmp.proto import rfc1902 from pysnmp import error -from pysnmp_apps.cli import base +from snmpclitools.cli import base # Read class diff --git a/pysnmp_apps/cli/secmod.py b/snmpclitools/cli/secmod.py similarity index 98% rename from pysnmp_apps/cli/secmod.py rename to snmpclitools/cli/secmod.py index 33f1206..2c5b448 100644 --- a/pysnmp_apps/cli/secmod.py +++ b/snmpclitools/cli/secmod.py @@ -1,10 +1,10 @@ # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # -from pysnmp_apps.cli import base +from snmpclitools.cli import base from pysnmp.entity import config from pysnmp import error diff --git a/pysnmp_apps/cli/spark.py b/snmpclitools/cli/spark.py similarity index 100% rename from pysnmp_apps/cli/spark.py rename to snmpclitools/cli/spark.py diff --git a/pysnmp_apps/cli/target.py b/snmpclitools/cli/target.py similarity index 97% rename from pysnmp_apps/cli/target.py rename to snmpclitools/cli/target.py index 52c9adf..478cdfe 100644 --- a/pysnmp_apps/cli/target.py +++ b/snmpclitools/cli/target.py @@ -1,13 +1,13 @@ # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # import socket -from pysnmp_apps.cli import base +from snmpclitools.cli import base from pysnmp.carrier.asynsock.dgram import udp, udp6 -from pysnmp_apps.error import SnmpApplicationError +from snmpclitools.error import SnmpApplicationError from pysnmp.entity import config from pysnmp import error diff --git a/pysnmp_apps/error.py b/snmpclitools/error.py similarity index 59% rename from pysnmp_apps/error.py rename to snmpclitools/error.py index 2e40488..9c457f3 100644 --- a/pysnmp_apps/error.py +++ b/snmpclitools/error.py @@ -1,8 +1,8 @@ # -# This file is part of pysnmp-apps software. +# This file is part of snmpclitools software. # # Copyright (c) 2005-2018, Ilya Etingof -# License: http://snmplabs.com/pysnmp/license.html +# License: http://snmplabs.com/snmpclitools/license.html # from pysnmp import error