Metadata-Version: 2.1
Name: localstack-extension-resource-graph
Version: 0.2.0.post1
Summary: Altimeter based LocalStack extension that allows you to create and import into neptune a graph of the resources in your LocalStack instance
Author-email: LocalStack Team <info@localstack.com>
Keywords: localstack,localstack-extension,extension
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8
Requires-Dist: gremlinpython
Requires-Dist: localstack_client
Requires-Dist: jsonpatch
Requires-Dist: pydantic
Requires-Dist: pydantic_settings
Requires-Dist: python-dateutil
Requires-Dist: PyYAML
Requires-Dist: rolo
Requires-Dist: jinja2
Requires-Dist: rdflib==6.0.2
Requires-Dist: requests
Requires-Dist: structlog
Requires-Dist: toml
Provides-Extra: dev
Requires-Dist: localstack>=0.0.0.dev; extra == "dev"

Resource Graph
===============================

All the boilerplate you need to create a LocalStack extension.

## Install local development version

To install the extension into localstack in developer mode, you will need Python 3.10+, and create a virtual environment in the extensions project.
You will also need to install [yarn](https://yarnpkg.com/getting-started/install) as package manager if you haven't already
In the newly generated project, simply run

```bash
make install
```

Then, to enable the extension for LocalStack, run

```bash
localstack extensions dev enable .
```

You can then start LocalStack with `EXTENSION_DEV_MODE=1` to load all enabled extensions:

```bash
EXTENSION_DEV_MODE=1 localstack start
```

## Developing UI
With this template is generated also a UI made in react that is available at either Resource Graph.localhost.localstack.cloud:4566/ or http://localhost.localstack.cloud:4566/_extension/Resource Graph/.

There are a few make commands available that will help your journey with the UI:
- **build-frontend**: will build the react app into the frontend/build folder which will then be passed into the extension itself allowing the UI to be seen. Remember to always execute this command when you wish to see new changes when using the extension.
- **start-frontend**: will start a live server on port 3000 (by default) that will allow you to have hot reloading when developing locally outside the extension (it will also build the frontend)


## Install from GitHub repository

To distribute your extension, simply upload it to your github account. Your extension can then be installed via:

```bash
localstack extensions install "git+https://github.com/janedoe/resource-graph/#egg=resource-graph"
```
