Skip to content

Commit c057650

Browse files
committed
Initial commit
0 parents  commit c057650

File tree

15 files changed

+1067
-0
lines changed

15 files changed

+1067
-0
lines changed

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
*.swp
2+
__pycache__
3+
.pytest_cache
4+
.venv
5+
*.egg-info
6+
.coverage
7+
.markdownlint*
8+
# CDK asset staging directory
9+
.cdk.staging
10+
cdk.out
11+
cdk.context.json

.pre-commit-config.yaml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
repos:
2+
- repo: https://github.com/pycqa/isort
3+
rev: 5.10.1
4+
hooks:
5+
- id: isort
6+
args: ["--profile", "black"]
7+
verbose: true
8+
- repo: https://github.com/psf/black
9+
rev: 21.12b0 # Replace with any tag/version: https://github.com/psf/black/tags
10+
hooks:
11+
- id: black
12+
language_version: python3 # Should be a command that runs python3.7+
13+
verbose: true
14+
- repo: https://gitlab.com/pycqa/flake8
15+
rev: 4.0.1
16+
hooks:
17+
- id: flake8
18+
args: ['--max-line-length=150', '--ignore=E203, A002', '--max-cognitive-complexity=14', '--max-expression-complexity=7' ]
19+
additional_dependencies: [
20+
flake8-bugbear, # Detect potential bugs
21+
flake8-builtins, # Check for built-ins being used as variables
22+
flake8-cognitive-complexity, # Check max function complexity
23+
flake8-comprehensions, # Suggestions for better list/set/dict comprehensions
24+
flake8-eradicate, # Find dead/commented out code
25+
flake8-expression-complexity, # Check max expression complexity
26+
flake8-fixme, # Check for FIXME, TODO, and XXX left in comments
27+
flake8-logging-format, # Validate (lack of) logging format strings
28+
flake8-mutable, # Check for mutable default arguments
29+
flake8-pie, # Misc. linting rules
30+
flake8-pytest-style, # Check against pytest style guide
31+
flake8-return, # Check return statements
32+
flake8-simplify, # Suggestions to simplify code
33+
flake8-use-fstring, # Encourages use of f-strings vs old style
34+
pep8-naming, # Check PEP8 class naming
35+
]
36+
verbose: true
37+
- repo: https://github.com/Lucas-C/pre-commit-hooks-safety
38+
rev: v1.2.2
39+
hooks:
40+
- id: python-safety-dependencies-check
41+
verbose: true
42+
- repo: https://github.com/awslabs/git-secrets
43+
rev: 80230afa8c8bdeac766a0fece36f95ffaa0be778
44+
hooks:
45+
- id: git-secrets
46+
verbose: true
47+
entry: 'git-secrets --register-aws'
48+
language: script
49+
name: git-secrets-register-aws-provider
50+
- id: git-secrets
51+
verbose: true
52+
entry: 'git-secrets --scan'
53+
language: script
54+
name: git-secrets-scan
55+
- repo: https://github.com/markdownlint/markdownlint
56+
rev: v0.11.0
57+
hooks:
58+
- id: markdownlint
59+
name: Markdownlint
60+
description: Run markdownlint on your Markdown files
61+
entry: mdl .
62+
language: ruby
63+
files: \.(md|mdown|markdown)$
64+
verbose: true
65+
args:
66+
- "-s"
67+
- "mdl_style.rb"
68+
- repo: https://github.com/PyCQA/bandit
69+
rev: '1.7.1'
70+
hooks:
71+
- id: bandit
72+
entry: bandit
73+
exclude: ^tests/
74+
verbose: true

CODE_OF_CONDUCT.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Code of Conduct
2+
3+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
4+
For more information see the
5+
[Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
6+
[email protected] with any additional questions or comments.

CONTRIBUTING.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to our project.
4+
Whether it's a bug report, new feature, correction, or additional
5+
documentation, we greatly value feedback and contributions from our community.
6+
7+
Please read through this document before submitting any
8+
issues or pull requests to ensure we have all the necessary
9+
information to effectively respond to your bug report or contribution.
10+
11+
## Reporting Bugs/Feature Requests
12+
13+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
14+
15+
When filing an issue, please check existing open, or recently closed,
16+
issues to make sure somebody else hasn't already
17+
reported the issue.
18+
Please try to include as much information as you can.
19+
Details like these are incredibly useful:
20+
21+
* A reproducible test case or series of steps
22+
* The version of our code being used
23+
* Any modifications you've made relevant to the bug
24+
* Anything unusual about your environment or deployment
25+
26+
## Contributing via Pull Requests
27+
28+
Contributions via pull requests are much appreciated.
29+
This repository use [pre-commit](https://pre-commit.com/) hooks for linting.
30+
Before sending us a pull request, please ensure that:
31+
32+
1. You are working against the latest source on the *main* branch.
33+
1. You check existing open, and recently merged,
34+
pull requests to make sure someone else hasn't addressed the problem already.
35+
1. You open an issue to discuss any significant work - we would hate
36+
for your time to be wasted.
37+
38+
To send us a pull request, please:
39+
40+
1. Fork the repository.
41+
1. Modify the source; please focus on the specific change you are contributing.
42+
If you also reformat all the code, it will be hard for us to focus on your change.
43+
1. Ensure local tests pass.
44+
1. Commit to your fork using clear commit messages.
45+
1. Send us a pull request, answering any default questions in the pull request interface.
46+
1. Pay attention to any automated CI failures reported in the pull request,
47+
and stay involved in the conversation.
48+
49+
> Note: you may need to update the commit if `pre-commit` changes/suggests changes to files
50+
51+
GitHub provides additional document on
52+
[forking a repository](https://help.github.com/articles/fork-a-repo/) and
53+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
54+
55+
## Finding contributions to work on
56+
57+
Looking at the existing issues is a great way to find something to contribute on.
58+
As our projects, by default, use the default GitHub issue labels
59+
(enhancement/bug/duplicate/help wanted/invalid/question/wontfix),
60+
looking at any 'help wanted' issues is a great place to start.
61+
62+
## Code of Conduct
63+
64+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
65+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq)
66+
or contact
67+
[email protected] with any additional questions or comments.
68+
69+
## Security issue notifications
70+
71+
If you discover a potential security issue in this project we ask
72+
that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
73+
Please do **not** create a public github issue.
74+
75+
## Licensing
76+
77+
See the [LICENSE](LICENSE) file for our project's licensing.
78+
We will ask you to confirm the licensing of your contribution.

LICENSE

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of
4+
this software and associated documentation files (the "Software"), to deal in
5+
the Software without restriction, including without limitation the rights to
6+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
7+
the Software, and to permit persons to whom the Software is furnished to do so.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
10+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
11+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
12+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
13+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
14+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
15+

0 commit comments

Comments
 (0)