# THipster
THipster is a tool dedicated to simplifying the difficulty associated with writing Terraform files.
It allows users to write infrastructure as code in a simplified format, using either YAML (with JINJA) or the dedicated Thipster DSL.
Written entirely in Python, it leverages the Python CDK for Terraform to create Terraform files and apply them to the chosen provider.
<p align="center">
<a href="https://github.com/THipster/THipster/blob/main/LICENSE" target="_blank" alt="License">
<img src="https://img.shields.io/github/license/THipster/THipster" alt="License">
</a>
<a href="https://thipster.readthedocs.io/en/latest/?badge=latest" target="_blank" alt="Read the docs documentation">
<img src="https://readthedocs.org/projects/thipster/badge/?version=latest" alt="Read the docs documentation">
</a>
<a href="https://pypi.org/project/thipster/" target="_blank" alt="PyPi package">
<img src="https://img.shields.io/pypi/v/thipster?color=brightgreen&label=pypi%20package" alt="Package version">
</a>
<a href="https://pypi.org/project/thipster/" target="_blank" alt="PyPi package">
<img src="https://img.shields.io/pypi/pyversions/thipster?color=brightgreen" alt="Supported Python versions">
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;">
</a>
<a href='https://coveralls.io/github/THipster/THipster'>
<img src='https://coveralls.io/repos/github/THipster/THipster/badge.svg' alt='Coverage Status' />
</a>
</p>
## Technology Stack
Written in Python 3.11, thipster is designed as a python package, to be used either as a standalone tool, or as a module inside a running process like a CI/CD pipeline.
## Project Status
THipster is currently in an active development state. If you want to know more, please check the [CHANGELOG](https://github.com/THipster/THipster/blob/main/CHANGELOG.md) for more details.
## Dependencies
In order to user THipster, you will need to have the following installed:
- [Python](https://www.python.org/downloads/) (3.11+)
- [pipenv](https://pipenv.pypa.io/en/latest/) v2021.5+
- [Terraform CLI](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) (1.2+)
- [Node.js](https://nodejs.org/) and npm v16+.
## Installation
To use THipster, you can simply install the package with pip:
```console
pip install thipster
```
If you want to install the google dependencies aswell use
```console
pip install thipster[google]
```
The list of available versions can be found on [PyPI](https://pypi.org/project/thipster/).
## Usage
You can use THipster in two ways:
- By leveraging the [THipster CLI](https://github.com/THipster/THipster-cli)
- By directly using the [THipster Python package](https://pypi.org/project/thipster/) in your own code
Main feature:
- Generate Terraform files from a YAML+JINJA or THIPS file:
```python
from thipster import Engine as ThipsterEngine
from thipster.auth import Google
from thipster.parser import ParserFactory
from thipster.repository import GithubRepo
from thipster.terraform import Terraform
# create new THipster engine
engine = ThipsterEngine(ParserFactory(), GithubRepo('THipster/models'), Google, Terraform())
# generate Terraform files and plan from a YAML+JINJA file
terraform_plan = engine.run('path/to/file/or/directory')
print(terraform_plan)
```
## How to test the software
To run the tests, you can use the following command:
```console
pip install -e .[test]
pytest tests
```
## Known issues
All known issues, bugs, and feature requests are tracked in the [Issue tracker](https://github.com/THipster/THipster/issues).
## Getting help
If you have questions, concerns, bug reports, etc, please file an issue in this repository's [Issue tracker](https://github.com/THipster/THipster/issues).
## Getting involved
To install the project for development, you can use the following command:
```console
pip install -r requirements.txt && pip install -e .[dev,test,doc,google]
pre-commit install && pre-commit run --all-files
```
For more information on how to help out, please check the [CONTRIBUTING](https://github.com/THipster/THipster/blob/main/CONTRIBUTING.md) file.
## Open source licensing info
1. [LICENSE](https://github.com/THipster/THipster/blob/main/LICENSE)
2. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)
## Credits and references
1. Projects that inspired you
- [AWS Application Composer](https://aws.amazon.com/application-composer/?nc1=h_ls)
2. Related projects
- [Wing Programming Language](https://www.winglang.io/)
Raw data
{
"_id": null,
"home_page": "https://github.com/THipster/THipster",
"name": "thipster",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "thipster,terraform,infrastructure,infrastructure-as-code,iac,generator,dsl,yaml",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/8c/98/5d036c15b1d3d437508d3072f1b80ccad62a1814d7036b3b614b79aacbc7/thipster-0.23.15.tar.gz",
"platform": null,
"description": "# THipster\n\nTHipster is a tool dedicated to simplifying the difficulty associated with writing Terraform files.\nIt allows users to write infrastructure as code in a simplified format, using either YAML (with JINJA) or the dedicated Thipster DSL.\n\nWritten entirely in Python, it leverages the Python CDK for Terraform to create Terraform files and apply them to the chosen provider.\n\n<p align=\"center\">\n <a href=\"https://github.com/THipster/THipster/blob/main/LICENSE\" target=\"_blank\" alt=\"License\">\n <img src=\"https://img.shields.io/github/license/THipster/THipster\" alt=\"License\">\n </a>\n <a href=\"https://thipster.readthedocs.io/en/latest/?badge=latest\" target=\"_blank\" alt=\"Read the docs documentation\">\n <img src=\"https://readthedocs.org/projects/thipster/badge/?version=latest\" alt=\"Read the docs documentation\">\n </a>\n <a href=\"https://pypi.org/project/thipster/\" target=\"_blank\" alt=\"PyPi package\">\n <img src=\"https://img.shields.io/pypi/v/thipster?color=brightgreen&label=pypi%20package\" alt=\"Package version\">\n </a>\n <a href=\"https://pypi.org/project/thipster/\" target=\"_blank\" alt=\"PyPi package\">\n <img src=\"https://img.shields.io/pypi/pyversions/thipster?color=brightgreen\" alt=\"Supported Python versions\">\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\" alt=\"Ruff\" style=\"max-width:100%;\">\n </a>\n <a href='https://coveralls.io/github/THipster/THipster'>\n <img src='https://coveralls.io/repos/github/THipster/THipster/badge.svg' alt='Coverage Status' />\n </a>\n</p>\n\n## Technology Stack\nWritten in Python 3.11, thipster is designed as a python package, to be used either as a standalone tool, or as a module inside a running process like a CI/CD pipeline.\n\n## Project Status\nTHipster is currently in an active development state. If you want to know more, please check the [CHANGELOG](https://github.com/THipster/THipster/blob/main/CHANGELOG.md) for more details.\n\n## Dependencies\n\nIn order to user THipster, you will need to have the following installed:\n- [Python](https://www.python.org/downloads/) (3.11+)\n- [pipenv](https://pipenv.pypa.io/en/latest/) v2021.5+\n- [Terraform CLI](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) (1.2+)\n- [Node.js](https://nodejs.org/) and npm v16+.\n\n## Installation\n\nTo use THipster, you can simply install the package with pip:\n\n```console\npip install thipster\n```\n\nIf you want to install the google dependencies aswell use\n\n```console\npip install thipster[google]\n```\n\nThe list of available versions can be found on [PyPI](https://pypi.org/project/thipster/).\n\n## Usage\n\nYou can use THipster in two ways:\n- By leveraging the [THipster CLI](https://github.com/THipster/THipster-cli)\n- By directly using the [THipster Python package](https://pypi.org/project/thipster/) in your own code\n\nMain feature:\n- Generate Terraform files from a YAML+JINJA or THIPS file:\n```python\nfrom thipster import Engine as ThipsterEngine\nfrom thipster.auth import Google\nfrom thipster.parser import ParserFactory\nfrom thipster.repository import GithubRepo\nfrom thipster.terraform import Terraform\n\n# create new THipster engine\nengine = ThipsterEngine(ParserFactory(), GithubRepo('THipster/models'), Google, Terraform())\n\n# generate Terraform files and plan from a YAML+JINJA file\nterraform_plan = engine.run('path/to/file/or/directory')\nprint(terraform_plan)\n```\n\n## How to test the software\n\nTo run the tests, you can use the following command:\n\n```console\npip install -e .[test]\npytest tests\n```\n\n## Known issues\n\nAll known issues, bugs, and feature requests are tracked in the [Issue tracker](https://github.com/THipster/THipster/issues).\n\n## Getting help\n\nIf you have questions, concerns, bug reports, etc, please file an issue in this repository's [Issue tracker](https://github.com/THipster/THipster/issues).\n\n## Getting involved\n\nTo install the project for development, you can use the following command:\n\n```console\npip install -r requirements.txt && pip install -e .[dev,test,doc,google]\npre-commit install && pre-commit run --all-files\n```\n\nFor more information on how to help out, please check the [CONTRIBUTING](https://github.com/THipster/THipster/blob/main/CONTRIBUTING.md) file.\n\n## Open source licensing info\n1. [LICENSE](https://github.com/THipster/THipster/blob/main/LICENSE)\n2. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)\n\n## Credits and references\n\n1. Projects that inspired you\n - [AWS Application Composer](https://aws.amazon.com/application-composer/?nc1=h_ls)\n2. Related projects\n - [Wing Programming Language](https://www.winglang.io/)\n",
"bugtrack_url": null,
"license": "",
"summary": "THipster is a tool dedicated to simplifying the difficulty associated with writing Terraform files. It allows users to write infrastructure as code in a simplified format, using either YAML (with JINJA) or the dedicated Thipster DSL.",
"version": "0.23.15",
"project_urls": {
"Download": "https://github.com/THipster/THipster.git",
"Homepage": "https://github.com/THipster/THipster"
},
"split_keywords": [
"thipster",
"terraform",
"infrastructure",
"infrastructure-as-code",
"iac",
"generator",
"dsl",
"yaml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "efe4f1031521cd026b26336303d761819bb65e65d72dee1eee4061700e7bff15",
"md5": "edb1566a1cddabde486115becf97f207",
"sha256": "42207dbe5e5348d60c33ced85ea2106a0d2a58446afe9772a8df4276f6213376"
},
"downloads": -1,
"filename": "thipster-0.23.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "edb1566a1cddabde486115becf97f207",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 64756,
"upload_time": "2023-11-22T12:28:41",
"upload_time_iso_8601": "2023-11-22T12:28:41.800979Z",
"url": "https://files.pythonhosted.org/packages/ef/e4/f1031521cd026b26336303d761819bb65e65d72dee1eee4061700e7bff15/thipster-0.23.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c985d036c15b1d3d437508d3072f1b80ccad62a1814d7036b3b614b79aacbc7",
"md5": "1feafe08e56027a15b9a118730e317b4",
"sha256": "5af053fa98ae7d97c570b7695e396b4628729172350104ad194832ba4b172c51"
},
"downloads": -1,
"filename": "thipster-0.23.15.tar.gz",
"has_sig": false,
"md5_digest": "1feafe08e56027a15b9a118730e317b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 51019,
"upload_time": "2023-11-22T12:28:43",
"upload_time_iso_8601": "2023-11-22T12:28:43.956614Z",
"url": "https://files.pythonhosted.org/packages/8c/98/5d036c15b1d3d437508d3072f1b80ccad62a1814d7036b3b614b79aacbc7/thipster-0.23.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 12:28:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "THipster",
"github_project": "THipster",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "thipster"
}
JSON
