Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 961 Bytes

USAGE.rst

File metadata and controls

42 lines (26 loc) · 961 Bytes
Raw

Usage

To develop on awsfindingsmanagerlib:

# The following commands require pipenv as a dependency

# To lint the project
_CI/scripts/lint.py

# To execute the testing
_CI/scripts/test.py

# To create a graph of the package and dependency tree
_CI/scripts/graph.py

# To build a package of the project under the directory "dist/"
_CI/scripts/build.py

# To see the package version
_CI/scripts/tag.py

# To bump semantic versioning [--major|--minor|--patch]
_CI/scripts/tag.py --major|--minor|--patch

# To upload the project to a pypi repo if user and password are properly provided
_CI/scripts/upload.py

# To build the documentation of the project
_CI/scripts/document.py

To use awsfindingsmanagerlib in a project:

from awsfindingsmanagerlib import Awsfindingsmanagerlib
awsfindingsmanagerlib = Awsfindingsmanagerlib()