diff --git a/README.md b/README.md index c01278b3..709b8ae5 100644 --- a/README.md +++ b/README.md @@ -129,14 +129,6 @@ changes is required before making the actual change. 7. A force option is provided to override idempotency. 8. Compare functions are provided - takes JSON output and provide a meaningful comparison. -## Example Code - -A sample `testisam.py` and `testisds.py` is provided. Provide details of your appliance and a user/password to authenticate. -Then call the functions needed. Run the code like you would any other Python script. - -e.g.: `python testisam.py` - -Note: the code requires PyYAML (for printing output in YAML) and importlib (dynamically load all packages) packages to work. ### Function Data Return Format ~~~~ @@ -150,18 +142,6 @@ Note: the code requires PyYAML (for printing output in YAML) and importlib (dyna Note: it is preferred to return warnings rather than send back a non-zero rc. -### Generic test script - -For simple tests, a modified version is provided that takes the username, password, hostname, method and options as arguments, with the option to perform a commit or not. -This makes sense for simple tests but for pytest or unittests, this is not useful. - -This avoids having to store credentials in a script and allows easier repeat of tests. - -Example: - -~~~~ -python testisam_cmd.py --hostname 192.168.1.1 --method "ibmsecurity.isam.web.iag.export.features.get" --commit -~~~~ ## Organization of code diff --git a/docs/changelog.md b/docs/changelog.md index e3ee81fe..b8812fee 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -2,10 +2,10 @@ ## Latest -- feature: proxy support (http_proxy and https_proxy only) -- fix: base/ssl_certificates/signer_certificate.py - don't error if get signer certificate returns nothing -- feature: update docker db_configuration with new parameters v10.0.8.0 and v11 -- removed: soliddb as option for docker db_configuration +- refactor: remove reference to test scripts, since these are not in the pypi build + +## 2025.11.14.0 + - feature: base/ssl_certificates/personal_certificate.py - idempotency - fix: base/management_ssl_certificate.py - update cryptography for idempotency, fixes known_issue - fix: aac/fido2/metadata_services - ensure integers @@ -13,6 +13,15 @@ ### Build & deploy - refactor: format to f-strings + +## 2025.10.9.0 + +- feature: proxy support (http_proxy and https_proxy only) +- fix: base/ssl_certificates/signer_certificate.py - don't error if get signer certificate returns nothing +- feature: update docker db_configuration with new parameters v10.0.8.0 and v11 +- removed: soliddb as option for docker db_configuration + +### Build & deploy - wip: ordering of pytests ## 2025.9.26.0 diff --git a/docs/index.md b/docs/index.md index 2c6cd925..2159303f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,3 +8,25 @@ ISAM appliance has the most mature code. Code for ISDS appliance is under development. Code for ISVG appliance is brand new (tested with 10.0.1.0 and higher only). + +## Example Code + +A sample `testisam.py` and `testisds.py` is provided. Provide details of your appliance and a user/password to authenticate. +Then call the functions needed. Run the code like you would any other Python script. + +e.g.: `python testisam.py` + +Note: the code requires PyYAML (for printing output in YAML) and importlib (dynamically load all packages) packages to work. + +### Generic test script + +For simple tests, a modified version is provided that takes the username, password, hostname, method and options as arguments, with the option to perform a commit or not. +This makes sense for simple tests but for pytest or unittests, this is not useful. + +This avoids having to store credentials in a script and allows easier repeat of tests. + +Example: + +~~~~ +python testisam_cmd.py --hostname 192.168.1.1 --method "ibmsecurity.isam.web.iag.export.features.get" --commit +~~~~ diff --git a/pyproject.toml b/pyproject.toml index 094ff542..997ef639 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta" [project] name = "ibmsecurity" -version = "2025.9.30.0" +version = "2025.11.14.0" authors = [ { name="IBM", email="secorch@wwpdl.vnet.ibm.com" }, ] @@ -53,7 +53,7 @@ bad-names = [ # pylint defaults + f,fh,v,id good-names = ["i", "j", "k", "Run", "_", "f", "fh", "v", "id", "T"] # Ignore as being generated: -ignore-paths = "^(examples|build|test/schemas/node_modules|.eggs|.cache|.direnv|.tox|.config/).*$" +ignore-paths = "^(examples|build|test/schemas/node_modules|.eggs|.cache|.direnv|.tox|.config).*$" [tool.pylint.REPORTING] output-format = "colorized" diff --git a/setup.py b/setup.py index 27d701c5..e8ca14ce 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ packages=find_packages(exclude=["test.*","test"]), # Date of release used for version - please be sure to use YYYY.MM.DD.seq#, MM and DD should be two digits e.g. 2017.02.05.0 # seq# will be zero unless there are multiple release on a given day - then increment by one for additional release for that date - version="2025.9.30.0", + version="2025.11.14.0", description="Idempotent functions for IBM Security Appliance REST APIs", author="IBM", author_email="secorch@wwpdl.vnet.ibm.com",