Metadata-Version: 2.1
Name: swa_cc.core
Version: 1.2.0
Summary: A set of core objects utilized by the rest of the SWA Cloud Catalog
Home-page: UNKNOWN
Author: Seth Dobson
Author-email: sd0408@gmail.com
License: UNKNOWN
Description: # SWA Secure S3 Storage Bucket Stack Library
        
        Define a S3 bucket that security will be proud of.
        
        `S3StorageBucketStack` exposes the following deploy-time attributes from the underlying `bucket` construct:
        
        * `bucketArn` - the ARN of the bucket (i.e. `arn:aws:s3:::bucket_name`)
        * `bucketName` - the name of the bucket (i.e. `bucket_name`)
        * `arnForObjects(pattern)` - the ARN of an object or objects within the bucket (i.e.
          `arn:aws:s3:::bucket_name/exampleobject.png` or
          `arn:aws:s3:::bucket_name/Development/*`)
        * `urlForObject(key)` - the URL of an object within the bucket (i.e.
          `https://s3.cn-north-1.amazonaws.com.cn/china-bucket/mykey`)
        
        `S3StorageBucketStack` exposes the following deploy-time methods from the underlying `bucket` construct:
        
        * `add_lifecycle_rule`
        * `add_metric`
        * `add_object_created_notification`
        * `add_object_removed_notificationself`
        * `add_event_notification`
        * `add_to_resource_policy`
        * `arn_for_objects`
        * `on_cloud_trail_event`
        * `on_cloud_trail_put_object`
        * `url_for_object`
        
        ## Helpfull commands
        
        * Package code for publishing. First increment the version in setup.py then run the following
          `python3 setup.py sdist bdist_wheel`
        * Publish code
          `python3 -m twine upload  dist/*`
        * Generate documentation
          `cd docs && make html`
        * Run unit tests
          `pytest --cov . --cov-report=html --html=testreport/report.html`
        * upload to sonar
          `sonar-scanner \`
          `-Dsonar.projectKey=swa_cc_secure_s3_storage_bucket \`
          `-Dsonar.sources=source\swa_cc \`
          `-Dsonar.host.url=https://sonar-tools.swacorp.com/EC \`
          `-Dsonar.login=eda1a69701cd879fe142e1c36b2ed3db6769a01c`
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
