===================
awsenergylabelercli
===================
A cli to label accounts and landing zones with energy labels based on Security Hub finding.
* Documentation: https://aws-energy-labeler-cli.readthedocs.io/en/latest/
Development Workflow
====================
The workflow supports the following steps
* lint
* test
* build
* document
* upload
* graph
These actions are supported out of the box by the corresponding scripts under _CI/scripts directory with sane defaults based on best practices.
Sourcing setup_aliases.ps1 for windows powershell or setup_aliases.sh in bash on Mac or Linux will provide with handy aliases for the shell of all those commands prepended with an underscore.
The bootstrap script creates a .venv directory inside the project directory hosting the virtual environment. It uses pipenv for that.
It is called by all other scripts before they do anything. So one could simple start by calling _lint and that would set up everything before it tried to actually lint the project
Once the code is ready to be delivered the _tag script should be called accepting one of three arguments, patch, minor, major following the semantic versioning scheme.
So for the initial delivery one would call
$ _tag --minor
which would bump the version of the project to 0.1.0 tag it in git and do a push and also ask for the change and automagically update HISTORY.rst with the version and the change provided.
So the full workflow after git is initialized is:
* repeat as necessary (of course it could be test - code - lint :) )
* code
* lint
* test
* commit and push
* develop more through the code-lint-test cycle
* tag (with the appropriate argument)
* build
* upload (if you want to host your package in pypi)
* document (of course this could be run at any point)
Important Information
=====================
This template is based on pipenv. In order to be compatible with requirements.txt so the actual created package can be used by any part of the existing python ecosystem some hacks were needed.
So when building a package out of this **do not** simple call
$ python setup.py sdist bdist_egg
**as this will produce an unusable artifact with files missing.**
Instead use the provided build and upload scripts that create all the necessary files in the artifact.
History
-------
0.0.1 (11-11-2021)
---------------------
* First code creation
0.1.0 (26-11-2021)
------------------
* First official release.
0.1.1 (02-12-2021)
------------------
* Additional details added to export of accounts. Instead of only the energy label, it now includes the number of findings per severity
0.1.2 (06-12-2021)
------------------
* Added allow/deny function for regions
0.1.3 (06-12-2021)
------------------
* Updated library version
0.1.4 (09-12-2021)
------------------
* Allow to export to the root of an S3 bucket
0.2.0 (14-12-2021)
------------------
* Bumped awsenergylabelerlib and added logic for exporting finding resource data and finding type data
0.3.0 (31-01-2022)
------------------
* Introduced single account mode and exporting of metrics only
0.3.1 (01-02-2022)
------------------
* Bumped library version to filter FAILED findings only
0.4.0 (03-03-2022)
------------------
* Updated help documentation
* Uses newest library version to not count suppressed findings to the label
0.4.1 (04-03-2022)
------------------
* Bumped lib version.
0.4.2 (04-03-2022)
------------------
* Bumped lib to get unique findings only.
0.4.3 (16-05-2022)
------------------
* Matching underlying library refactoring.
1.0.0 (16-05-2022)
------------------
* Matching underlying library refactoring.
1.0.1 (11-07-2022)
------------------
* Fixed list.append
1.1.0 (13-09-2022)
------------------
* Added option to set environment variables instead of CLI flags.
1.1.1 (26-09-2022)
------------------
* Bumped library version
1.1.2 (26-09-2022)
------------------
* Bumped lib version
1.1.3 (04-10-2022)
------------------
* Fixed framework filtering for single accounts
2.0.0 (25-10-2022)
------------------
* Made region a required argument
3.0.0 (17-11-2022)
------------------
* Major update including the possibility to create a metadata file containing details on the execution.
* Now audit zones are supported, for environments without access to AWS Organizations.
* It is possible to use custom SecurityHub query filters and score thresholds.
3.0.1 (23-11-2022)
------------------
* Reporting on enabled integrations in SecurityHub
3.1.0 (23-11-2022)
------------------
* Reporting on enabled integrations in SecurityHub
3.2.0 (08-03-2023)
------------------
* Added flag to disable printing the banner
3.2.1 (10-03-2023)
------------------
* Bump dependencies.
3.2.2 (11-04-2023)
------------------
* Added support for Python3.11
3.2.3 (13-04-2023)
------------------
* Bumped library - Changed dataclass to normal class
3.2.4 (24-04-2023)
------------------
* Bumped library to support read-only filesystems when exporting to S3
3.2.5 (06-06-2023)
------------------
* Implement support for consolidated findings.
3.2.6 (01-12-2023)
------------------
* Update dependencies.
Raw data
{
"_id": null,
"home_page": "https://github.com/schubergphilis/awsenergylabelercli.git",
"name": "awsenergylabelercli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "awsenergylabelercli energy labeler aws security hub",
"author": "Theodoor Scholte",
"author_email": "tscholte@schubergphilis.com",
"download_url": "https://files.pythonhosted.org/packages/d9/80/65452fbcd4613c92d934cf6aca617608cac2a09bbf0a909de1159bd42f07/awsenergylabelercli-3.2.6.tar.gz",
"platform": null,
"description": "===================\nawsenergylabelercli\n===================\n\nA cli to label accounts and landing zones with energy labels based on Security Hub finding.\n\n\n* Documentation: https://aws-energy-labeler-cli.readthedocs.io/en/latest/\n\n\nDevelopment Workflow\n====================\n\nThe workflow supports the following steps\n\n * lint\n * test\n * build\n * document\n * upload\n * graph\n\nThese actions are supported out of the box by the corresponding scripts under _CI/scripts directory with sane defaults based on best practices.\nSourcing setup_aliases.ps1 for windows powershell or setup_aliases.sh in bash on Mac or Linux will provide with handy aliases for the shell of all those commands prepended with an underscore.\n\nThe bootstrap script creates a .venv directory inside the project directory hosting the virtual environment. It uses pipenv for that.\nIt is called by all other scripts before they do anything. So one could simple start by calling _lint and that would set up everything before it tried to actually lint the project\n\nOnce the code is ready to be delivered the _tag script should be called accepting one of three arguments, patch, minor, major following the semantic versioning scheme.\nSo for the initial delivery one would call\n\n $ _tag --minor\n\nwhich would bump the version of the project to 0.1.0 tag it in git and do a push and also ask for the change and automagically update HISTORY.rst with the version and the change provided.\n\n\nSo the full workflow after git is initialized is:\n\n * repeat as necessary (of course it could be test - code - lint :) )\n\n * code\n * lint\n * test\n * commit and push\n * develop more through the code-lint-test cycle\n * tag (with the appropriate argument)\n * build\n * upload (if you want to host your package in pypi)\n * document (of course this could be run at any point)\n\n\nImportant Information\n=====================\n\nThis template is based on pipenv. In order to be compatible with requirements.txt so the actual created package can be used by any part of the existing python ecosystem some hacks were needed.\nSo when building a package out of this **do not** simple call\n\n $ python setup.py sdist bdist_egg\n\n**as this will produce an unusable artifact with files missing.**\nInstead use the provided build and upload scripts that create all the necessary files in the artifact.\n\n\n\n\nHistory\n-------\n\n0.0.1 (11-11-2021)\n---------------------\n\n* First code creation\n\n\n0.1.0 (26-11-2021)\n------------------\n\n* First official release.\n\n\n0.1.1 (02-12-2021)\n------------------\n\n* Additional details added to export of accounts. Instead of only the energy label, it now includes the number of findings per severity\n\n\n0.1.2 (06-12-2021)\n------------------\n\n* Added allow/deny function for regions\n\n\n0.1.3 (06-12-2021)\n------------------\n\n* Updated library version\n\n\n0.1.4 (09-12-2021)\n------------------\n\n* Allow to export to the root of an S3 bucket\n\n\n0.2.0 (14-12-2021)\n------------------\n\n* Bumped awsenergylabelerlib and added logic for exporting finding resource data and finding type data\n\n\n0.3.0 (31-01-2022)\n------------------\n\n* Introduced single account mode and exporting of metrics only\n\n\n0.3.1 (01-02-2022)\n------------------\n\n* Bumped library version to filter FAILED findings only\n\n\n0.4.0 (03-03-2022)\n------------------\n\n* Updated help documentation\n* Uses newest library version to not count suppressed findings to the label\n\n\n0.4.1 (04-03-2022)\n------------------\n\n* Bumped lib version.\n\n\n0.4.2 (04-03-2022)\n------------------\n\n* Bumped lib to get unique findings only.\n\n\n0.4.3 (16-05-2022)\n------------------\n\n* Matching underlying library refactoring.\n\n\n1.0.0 (16-05-2022)\n------------------\n\n* Matching underlying library refactoring.\n\n\n1.0.1 (11-07-2022)\n------------------\n\n* Fixed list.append\n\n\n1.1.0 (13-09-2022)\n------------------\n\n* Added option to set environment variables instead of CLI flags.\n\n\n1.1.1 (26-09-2022)\n------------------\n\n* Bumped library version\n\n\n1.1.2 (26-09-2022)\n------------------\n\n* Bumped lib version\n\n\n1.1.3 (04-10-2022)\n------------------\n\n* Fixed framework filtering for single accounts\n\n\n2.0.0 (25-10-2022)\n------------------\n\n* Made region a required argument\n\n\n3.0.0 (17-11-2022)\n------------------\n\n* Major update including the possibility to create a metadata file containing details on the execution.\n* Now audit zones are supported, for environments without access to AWS Organizations.\n* It is possible to use custom SecurityHub query filters and score thresholds.\n\n\n3.0.1 (23-11-2022)\n------------------\n\n* Reporting on enabled integrations in SecurityHub\n\n\n\n3.1.0 (23-11-2022)\n------------------\n\n* Reporting on enabled integrations in SecurityHub\n\n\n3.2.0 (08-03-2023)\n------------------\n\n* Added flag to disable printing the banner\n\n\n3.2.1 (10-03-2023)\n------------------\n\n* Bump dependencies.\n\n\n3.2.2 (11-04-2023)\n------------------\n\n* Added support for Python3.11\n\n\n3.2.3 (13-04-2023)\n------------------\n\n* Bumped library - Changed dataclass to normal class\n\n\n3.2.4 (24-04-2023)\n------------------\n\n* Bumped library to support read-only filesystems when exporting to S3\n\n\n3.2.5 (06-06-2023)\n------------------\n\n* Implement support for consolidated findings.\n\n\n3.2.6 (01-12-2023)\n------------------\n\n* Update dependencies.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A cli to label accounts and landing zones with energy labels based on Security Hub finding.",
"version": "3.2.6",
"project_urls": {
"Homepage": "https://github.com/schubergphilis/awsenergylabelercli.git"
},
"split_keywords": [
"awsenergylabelercli",
"energy",
"labeler",
"aws",
"security",
"hub"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d98065452fbcd4613c92d934cf6aca617608cac2a09bbf0a909de1159bd42f07",
"md5": "9e71ac105a4039ffff49535d4eb73093",
"sha256": "1a999fe52da6f760043ee40216755dc62a8bf80306b5052470db1ffc45fcf109"
},
"downloads": -1,
"filename": "awsenergylabelercli-3.2.6.tar.gz",
"has_sig": false,
"md5_digest": "9e71ac105a4039ffff49535d4eb73093",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 102004,
"upload_time": "2023-12-01T15:06:54",
"upload_time_iso_8601": "2023-12-01T15:06:54.568096Z",
"url": "https://files.pythonhosted.org/packages/d9/80/65452fbcd4613c92d934cf6aca617608cac2a09bbf0a909de1159bd42f07/awsenergylabelercli-3.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-01 15:06:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "schubergphilis",
"github_project": "awsenergylabelercli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "awsenergylabelercli"
}
JSON
