vm-console-client

Python library for the InsightVM/Nexpose RESTful API.

Author: Muhammad-Rebaal

Install

pip install vm-console-client

Then import:

import rapid7vmconsole

Quick Setup (from source)

cd vm-console-client-python
python3 -m venv env
source env/bin/activate   # Windows: env\Scripts\activate
pip install -r requirements.txt
pip install .

Run one of the sample clients:

mv samples/list_assets.py .
# Edit username, password, and host in list_assets.py
python list_assets.py

Publish to PyPI

Package name on PyPI: vm-console-client
Import name after install: rapid7vmconsole
Author: Muhammad-Rebaal

1. Create a PyPI account

1. Sign up at https://pypi.org/account/register/
2. Enable 2FA (required for uploading)
3. Create an API token: Account settings → API tokens → “Add API token”
   • Scope: “Entire account” for the first upload, or project-scoped after the project exists
   • Copy the token (starts with pypi-…) — you only see it once

Optional but recommended: also create an account on https://test.pypi.org and test-upload there first.

2. Build the package (from this folder)

pip install --upgrade build twine
python -m build

This creates dist/vm_console_client-<version>-py3-none-any.whl and .tar.gz.

3. (Optional) Upload to TestPyPI first

python -m twine upload --repository testpypi dist/*

When prompted:

• Username: __token__
• Password: paste your TestPyPI API token (including the pypi- prefix)

Install from TestPyPI to verify:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ vm-console-client
python -c "import rapid7vmconsole; print(rapid7vmconsole.__author__, rapid7vmconsole.__version__)"

4. Upload to real PyPI

# Rebuild if you changed anything, or remove old dist/ first:
# Remove-Item -Recurse -Force dist   # PowerShell
# rm -rf dist                        # bash
python -m build
python -m twine upload dist/*

Username: __token__
Password: your PyPI API token

5. Install and use

pip install vm-console-client

import rapid7vmconsole

print(rapid7vmconsole.__author__)   # Muhammad-Rebaal
print(rapid7vmconsole.__version__)

Bump VERSION in setup.py (and __version__ in rapid7vmconsole/__init__.py) before each new release — PyPI does not allow re-uploading the same version.

Auto-generating code

The library can be regenerated from an InsightVM/Nexpose Swagger file using Swagger Codegen. An example command:

java -jar swagger-codegen-cli-2.3.0.jar generate \
         -i api-files/console-swagger-6.5.5.json \
         -l python \
         -o ./ \
         -c setup_workspace/config.json

Versioning and Releases

Generated libraries follow X.Y.Z console versioning.