معرفی شرکت ها
cfn-docgen-0.1.3
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Document generator from cfn template files.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | OS Independent |
| نام فایل | cfn-docgen-0.1.3 |
| نام | cfn-docgen |
| نسخه کتابخانه | 0.1.3 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Takehiro Horie |
| ایمیل نویسنده | horie.takehiro@outlook.jp |
| آدرس صفحه اصلی | https://github.com/horietakehiro/cfn-docgen |
| آدرس اینترنتی | https://pypi.org/project/cfn-docgen/ |
| مجوز | MIT License |
# cfn-docgen
<!--  -->
---
cfn-docgen is a command line tool that generates the table formatted CloudFormation(cfn) definition file from the original, yaml or json formatted template file.
---
## Example
If you have a yaml cfn template file like below,
```Yaml
AWSTemplateFormatVersion: 2010-09-09
Description: sample vpc template
Parameters:
EnvType:
Description: env type
Type: String
Default: dev
Resources:
VPC:
Type: AWS::EC2::VPC
Metadata:
UserNotes:
ResourceNote: This is a note for VPC resource
PropNotes:
CidrBlock: This is a note for CidrBlock prop
Tags[1].Value: This is a note for Value prop of 2nd Tags list prop
Properties:
CidrBlock: 10.0.0.0/16
EnableDnsSupport: true
Tags:
- Key: ENV
Value: !Ref EnvType
- Key: Name
Value: SampleVpc
```
you can generate a content like below.
| ResourceId | ResourceType | ResourceNote | Property | Value | UserNote | Required | Type | UpdateType | Description | IsOmittable | Filename |
|:-------------|:---------------|:---------------------------|:-------------------|:------------|:--------------------------------------------|:-----------|:------------|:-------------|:------------------------------------------------------------------------------------------------|:--------------|:-----------|
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | CidrBlock | 10.0.0.0/16 | これはCidrBlockプロパティに対するユーザ独自のコメントです | False | String | Immutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html | False | cfn.yaml |
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | EnableDnsHostnames | | | False | Boolean | Mutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html | True | cfn.yaml |
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | EnableDnsSupport | | | False | Boolean | Mutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html | True | cfn.yaml |
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | InstanceTenancy | | | False | String | Mutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html | True | cfn.yaml |
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | Ipv4IpamPoolId | | | False | String | Immutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html | True | cfn.yaml |
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | Ipv4NetmaskLength | | | False | Integer | Immutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html | True | cfn.yaml |
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | Tags | | | False | List of Tag | Mutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html | False | cfn.yaml |
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | Tags[0].Key | ENV | | True | String | Mutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html | False | cfn.yaml |
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | Tags[0].Value | DEV | | True | String | Mutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html | False | cfn.yaml |
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | Tags[1].Key | DEPARTMENT | これはTagsプロパティ配列の2番目のKeyプロパティに対するユーザ独自のコメントです | True | String | Mutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html | False | cfn.yaml |
| VPC | AWS::EC2::VPC | これはVPCリソースに対するユーザ独自のコメントです | Tags[1].Value | DTBD | | True | String | Mutable | http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html | False | cfn.yaml |
The key features of this tool are,
- All of the properties of each resource, including ones you omit to define, are listed in generated file.
- In the example above, properties `EnableDnsHostnames`, `InstanceTenancy`, `Ipv4IpamPoolId`, and `Ipv4NetmaskLength` are omitted in original cfn template file, but listed in generated file.
- References for each resource and property listed at [official User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) are merged in generated file as columns `Required`, `Type`, `UpdateType`, and `Description`.
- You can add custom notes for each resource and property at `Metadata` section in each resource.
- You can add custom note for a resource at `Metadata.UserNotes.ResourceNote`
- You can add custom notes for properties at `Metadata.UserNotes.PropNotes.{PropertyName}`
- For nested or list properties, you can specify `PropertyName` like `Tags[1].Value` .
- Not only `Resources` section in cfn template, this tool can also generate definitions of other sections, including `Parameters`, `Mappings`, and `Outputs` and resource policies like `CreationPolicy`, `UpdatePolicy`, `UpdateReplacePlocy`, `DeletionPolicy`, and `DependsOn`.
- You can generate files as excel, md, csv, or html format.
- In excel format, all of definitions are separated by sheets.
- In other format, all of definitions are separated by files.
Full example is in [sample](./sample) directory.
---
## Requirements(CLI)
- python3.8
- AWS CLI
---
## Installation(CLI)
```Bash
$ pip install cfn-docgen
```
---
## Installation(GUI)
We also provide cfn-docgen as GUI application [here](https://github.com/horietakehiro/cfn-docgen-gui).
---
## Installation(serverless)
You can also use cfn-docgen on AWS Cloud as serverless application.
You can deploy resources at [AWS Serverless Application Repository](https://ap-northeast-1.console.aws.amazon.com/lambda/home?region=ap-northeast-1#/create/app?applicationId=arn:aws:serverlessrepo:ap-northeast-1:382098889955:applications/cfn-docgen-serverless). Once deployed, tha S3 bucket named `cfn-docgen-${AWS::AccountId}-${AWS::Region}` is created on your account. When you upload cfn template json/yaml files at `templates/` folder of the bucket, cfn-docgen-serverless automatically will be triggered and generates excel docments for them.
---
## Command usage
```Bash
$ cfn-docgen --help
Usage: cfn-docgen [OPTIONS]
Document generator from cfn template files
Options:
--in TEXT Input cfn template file path (yaml/json)
[required]
--fmt [xlsx|md|csv|html] Output file format. [default: xlsx]
--omit If set, optional properties whose actual values
are not set in input template file will not be
written in output file.
--refresh If set, fristly remove all existing cache files
and download them again.
--region TEXT AWS region name for referencing resource specs. If
not set, the value set as environment variable
`CFN_DOCGEN_AWS_REGION` is used. If the
environment variable is not set, use the value of
AWS CLI default profile
--verbose If set, stdout DEBUG level logs
--help Show this message and exit.
# example command usage
$ cfn-docgen --in sample/sample-template.json --fmt html
```
نیازمندی
| مقدار | نام |
|---|---|
| ==21.4.0 | attrs |
| ==4.11.1 | beautifulsoup4 |
| ==5.0.1 | bleach |
| ==1.24.20 | boto3 |
| ==1.27.20 | botocore |
| ==0.0.1 | bs4 |
| ==2022.6.15 | certifi |
| ==1.15.1 | cffi |
| ==1.3.0 | cfn-flip |
| ==2.1.0 | charset-normalizer |
| ==8.1.3 | click |
| ==0.1.5 | colour |
| ==0.9.1 | commonmark |
| ==6.4.1 | coverage |
| ==37.0.2 | cryptography |
| ==0.18.1 | docutils |
| ==1.1.0 | et-xmlfile |
| ==3.3 | idna |
| ==4.12.0 | importlib-metadata |
| ==5.8.0 | importlib-resources |
| ==1.1.1 | iniconfig |
| ==0.8.0 | jeepney |
| ==1.0.1 | jmespath |
| ==4.6.1 | jsonschema |
| ==23.6.0 | keyring |
| ==1.23.0 | numpy |
| ==3.0.10 | openpyxl |
| ==21.3 | packaging |
| ==1.4.3 | pandas |
| ==0.8.1 | parameterized |
| ==20.2.3 | pip |
| ==1.8.3 | pkginfo |
| ==1.0.0 | pluggy |
| ==1.11.0 | py |
| ==2.21 | pycparser |
| ==2.12.0 | Pygments |
| ==3.0.9 | pyparsing |
| ==0.18.1 | pyrsistent |
| ==7.1.2 | pytest |
| ==3.0.0 | pytest-cov |
| ==2.8.2 | python-dateutil |
| ==2022.1 | pytz |
| ==6.0 | PyYAML |
| ==35.0 | readme-renderer |
| ==2.28.1 | requests |
| ==0.9.1 | requests-toolbelt |
| ==2.0.0 | rfc3986 |
| ==12.4.4 | rich |
| ==0.6.0 | s3transfer |
| ==3.3.2 | SecretStorage |
| ==49.2.1 | setuptools |
| ==1.16.0 | six |
| ==2.3.2.post1 | soupsieve |
| ==4.1 | styleframe |
| ==0.8.10 | tabulate |
| ==2.0.1 | tomli |
| ==4.64.0 | tqdm |
| ==4.0.1 | twine |
| ==4.2.0 | typing-extensions |
| ==1.26.9 | urllib3 |
| ==0.5.1 | webencodings |
| ==0.37.1 | wheel |
| ==3.0.3 | XlsxWriter |
| ==3.8.0 | zipp |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.8 | Python |
نحوه نصب
نصب پکیج whl cfn-docgen-0.1.3:
pip install cfn-docgen-0.1.3.whl
نصب پکیج tar.gz cfn-docgen-0.1.3:
pip install cfn-docgen-0.1.3.tar.gz