Skip to main content

A parser for HCL2

Project description

Build Status License PyPI Python Versions Downloads

Notice

This is a fork of the Python HCL2 repo by Amplify and is officially supported by Bridgecrew. We contributed as much as possible to the upstream project, but the two projects are now deviating in a way that pushing new changes upstream doesn't make sense anymore.

Python HCL2

A parser for HCL2 written in Python using Lark. This parser only supports HCL2 and isn't backwards compatible with HCL v1. It can be used to parse any HCL2 config file such as Terraform.

About Amplify

Amplify builds innovative and compelling digital educational products that empower teachers and students across the country. We have a long history as the leading innovator in K-12 education - and have been described as the best tech company in education and the best education company in tech. While others try to shrink the learning experience into
the technology, we use technology to expand what is possible in real classrooms with real students and teachers.

Learn more at https://www.amplify.com

Getting Started

Prerequisites

python-hcl2 requires Python 3.6.0 or higher to run.

Installing

This package can be installed using pip

pip3 install python-hcl2

Usage

import hcl2
with open('foo.tf', 'r') as file:
    dict = hcl2.load(file)

Building From Source

For development, tox>=2.9.1 is recommended.

Running Tests

python-hcl2 uses tox. You will need to install tox with pip install tox. Running tox will automatically execute linters as well as the unit tests.

You can also run them individually with the -e argument.

For example, tox -e py37-unit will run the unit tests for python 3.7

To see all the available options, run tox -l.

Responsible Disclosure

If you have any security issue to report, contact project maintainers privately. You can reach us at mailto:github@amplify.com

Contributing

We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you:

  1. For any sizable change, first open a GitHub issue to discuss your idea.
  2. Create a pull request. Explain why you want to make the change and what it’s for.

We’ll try to answer any PR’s promptly.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bc-python-hcl2-0.3.51.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bc_python_hcl2-0.3.51-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file bc-python-hcl2-0.3.51.tar.gz.

File metadata

  • Download URL: bc-python-hcl2-0.3.51.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for bc-python-hcl2-0.3.51.tar.gz
Algorithm Hash digest
SHA256 15bfecbae882ead998dd9300737237a14e40dfd8c973e5c7de7b4c92040a010f
MD5 b7e8690a8c3b2370ca3eda9c12832769
BLAKE2b-256 833023d56ecb6c572f84abd506a8af9e03fcccd69d342e7eafd25688d0ba46c1

See more details on using hashes here.

File details

Details for the file bc_python_hcl2-0.3.51-py3-none-any.whl.

File metadata

File hashes

Hashes for bc_python_hcl2-0.3.51-py3-none-any.whl
Algorithm Hash digest
SHA256 ab72880dd58689a4ee9a47f229788311a2b4d607fe034a819a40a63dab432644
MD5 f2173d8930096a389171d2bc99bbf641
BLAKE2b-256 da55dab1bf44f7c5ac45226ea76c782e21f9305e9b04ae61dbc0c5242696307d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page