pyTenable Modernization

Open
#1,034 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
15/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Active
Tech stack
python

Research direction

Start by inventorying the TenableIO, TenableASM, TenableAPA, TenableOne, and Identity packages, then review how Pydantic, Marshmallow, sync/async classes, and pytest-vcr are currently used. Break the modernization into separately testable areas and define completion for package consolidation, validation, returned objects, legacy-code cleanup, and the replacement test suite.

Written by the indexing model from the issue text.

Description

  • Collapse the TenableIO, TenableASM, TenableAPA, and TenableOne packages into a single package called TenableCloud.
  • Perform stronger validation with both the request and the response using Pydantic models.
  • Return the Pydantic objects whenever possible to handle a lot of the data manipulation that folks have to do with the data anyway.
  • Build support for both Sync and Async within their own respective classes,
  • Perform a lot of code cleanup.
  • Marshmallow usage still in the Identity package.  This needs to be retired.
  • A lot of very legacy code back from when we had to support down to 2.6.
  • Refactor a lot of nasty hacks now that more modern approaches can be done (I’m looking at you editor API).
  • Replace the old (and frail) pytest-vcr testing suite with a new one that allows us to better mock and test some of the endpoints that couldn’t be recorded.
Dominant language
Python
Stars
417
Forks
190
Avg merge
3d 22h
Merged PRs (30d)
7

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tenable/pyTenable

All issues in tenable/pyTenable

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.