Skip to main content

A parser for HCL2

Project description

Codacy Badge Codacy Badge Build Status License PyPI Python Versions Downloads

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

Getting Started


python-hcl2 requires Python 3.7 or higher to run.


This package can be installed using pip

pip3 install python-hcl2


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

Building From Source

For development, tox>=4.0.9 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.


To create a new releaes go to Releases page, press 'Draft a new release', create a tag with a version you want to be released, fill the release notes and press 'Publish release'. Github actions will take care of publishing it to PyPi.

Responsible Disclosure

If you have any security issue to report, contact project maintainers privately. You can reach us at


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

  • For any sizable change, first open a GitHub issue to discuss your idea.
  • 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

python-hcl2-4.3.2.tar.gz (19.2 kB view hashes)

Uploaded source

Built Distribution

python_hcl2-4.3.2-py3-none-any.whl (11.2 kB view hashes)

Uploaded py3

Supported by

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