Metadata-Version: 2.1
Name: com.castsoftware.uc.action-plan
Version: 1.0.1
Summary: Generate an action plan for CAST Software rule violations
Home-page: https://github.com/CAST-Extend/com.castsoftware.uc.action-plan
Author: Nevin Kaplan
Author-email: n.kaplan@castsoftware.com
Project-URL: Homepage, https://github.com/CAST-Extend/com.castsoftware.uc.action-plan
Project-URL: Bug Tracker, https://github.com/pypa/sampleproject/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: com.castsoftware.uc.python.common
Requires-Dist: et-xmlfile
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: psycopg2
Requires-Dist: python-dateutil
Requires-Dist: pytz
Requires-Dist: six

# Action Plan Generation Tool

The script is used to to automate the sorting for the Action Plan violations on the database.   

## Installation

* Download and unpack the latest release of Action Plan Generation Tool.
    * Source Code (zip)
    * com.castsoftware.uc.action-plan
    * Unpack the Source Code zip file (arg)

* Add the rules.xlsx file into your Action Plan Generation Tool folder

  
## Usage
The script is designed to run on the command line using 5 parameters, --application, --rules, --output, --host and --port. Used to identify the application, the excel rules file path and the output excel application path.

* Create a virtual env 
```Python -m venv .venv```
* Activate the virtual environment
```.\.venv\scripts\activate```
* Install
```pip install com.castsoftware.uc.action-plan```
* Use the commande line to launch the automated action plan
```python -m cast_action_plan.main -a <application name> -c <configuration file>```

## General Configuration
The general configuration section contains three parts, 
* host - Database host name
* port - Database port number 
* application - application name
* rules - the absolute location of the excel rules template
* output - the absolute location of the excel output application 

### Output 

This code allows to identify the important violations of the targeted application. The final data are push in the viewer_action_plan table of the corresponding application.
   
### Sample configuration

{
  "project":"Project Name",
  "template":"The absolute location of the excel rules template",
    
  "Configuration":{
      "Database":{
          "database": "postgres",
          "user": "*****",
          "password": "****",
          "host": "<host name>",
          "port": "####"
		  }
    }
}
