Metadata-Version: 2.1
Name: act-utils
Version: 2.1.0
Summary: ACT utilities
Home-page: https://github.com/mnemonic-no/act-utils
Author: mnemonic AS
Author-email: opensource@mnemonic.no
License: MIT
Keywords: ACT,mnemonic
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: ISC License (ISCL)
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4
Description-Content-Type: text/markdown
License-File: LICENSE

# ACT Utilities

## Introduction

This repository contains utility scripts for the [ACT Platform](https://github.com/mnemonic-no/act-platform).

## Installation
1. This project requires that you have a running installation of the [act-platform](https://github.com/mnemonic-no/act-platform).
2. Install from pip
```bash
pip install act-utils
```

## act-graph-datamodel usage

Build a graph (graphviz) of the ACT data model.
```bash
act-graph-datamodel --help
usage: act-graph-datamodel [-h] [--uid UID] [--http_username HTTP_USERNAME]
                           [--http_password HTTP_PASSWORD]
                           [--parent_id PARENT_ID]
                           [--confluence_url CONFLUENCE_URL]
                           [--confluence_user CONFLUENCE_USER]
                           [--confluence_password CONFLUENCE_PASSWORD]
                           url
```

# Local development

Use pip to install in [local development mode](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs). act-utils (and act-api) uses namespacing, so it is not compatible with using `setup.py install` or `setup.py develop`.

In repository, run:

```bash
pip3 install --user -e .
```
