Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust project structure and introduce pyproject.toml #3

Merged
merged 1 commit into from Feb 24, 2022

Conversation

mbeacom
Copy link
Contributor

@mbeacom mbeacom commented Feb 24, 2022

Issue #, if available: #2

Description of changes: The goal of this PR is to format the project to conform to a standard python package and add a toplevel pyproject.toml to handle package/dep management, venv management, and publishing while also conforming to a versioning python package structure.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

#// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#// SPDX-License-Identifier: Apache-2.0
# AWS CloudSaga - Simulate security events in AWS
# Joshua "DozerCat" McKiddy - Customer Incident Response Team (CIRT) - AWS


import logging
import boto3
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed superfluous imports here

main()
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

newline character

@@ -21,7 +21,7 @@


sts = boto3.client('sts')
region = os.environ['AWS_REGION']
region = os.environ.get('AWS_REGION', 'us-east-1')
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This resolves a default workflow bombing out when attempting cloudsaga -h if AWS_REGION is not set.

python = "^3.9"
boto3 = "^1.21.7"

[tool.poetry.dev-dependencies]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are some opinionated, common tools for formatting, linting, SAST, etc.


[tool.poetry.dependencies]
python = "^3.9"
boto3 = "^1.21.7"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Package deps

@hackersifu hackersifu linked an issue Feb 24, 2022 that may be closed by this pull request
@hackersifu hackersifu changed the base branch from main to 1.0.1 February 24, 2022 22:21
@hackersifu hackersifu self-assigned this Feb 24, 2022
@hackersifu hackersifu added the enhancement New feature or request label Feb 24, 2022
@hackersifu hackersifu merged commit ecc7c5c into awslabs:1.0.1 Feb 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request: formal package and entrypoint
2 participants