Installation and Usage

Installation ¶

Trust3 is a python library which can be installed using pip.

1
2

pip install paig-server
python -m spacy download en_core_web_lg

Usage ¶

Trust3 can be used in following ways:

1. Run as a service:
   You can simply run the Trust3 as a service by running following command:

   Bash
   1	paig run

   To get the help for the command and see all available [OPTIONS], you can run the following command:

   Bash
   1	paig --help

   Example:

   Bash
   1	paig run --port 4545 --host 0.0.0.0

2. Run as an Embedded Service:
   You can run Trust3 in background by importing the library in your Python code. Please run the help command to see all available options you can pass while calling the launch_app method.

   Python
   1 2 3 4 5 6 7 8 9 10 11 12	from paig import launcher # Start the Trust3 session = launcher.launch_app() # To get active sessions active_session = launcher.get_active_session() print(active_session) # To view the Trust3 in the browser/Iframe print(active_session.url) # To view the Trust3 in the Iframe active_session.view() # To stop the Trust3 launcher.close_app()

   You can simply run the Trust3 as a service by running following command:

Trust3 Server Background Mode ¶

Trust3 can be run in the background mode by setting the background flag to true.

1. To Start the Trust3 in the background mode:

   Bash
   1	paig run --background true

   Note: Please use help command to see all available options you can pass on command line.

   Bash
   1	paig --help

2. To Stop the Trust3 Server:

   Bash
   1	paig stop

3. To Check the status of the Trust3 Server:

   Bash
   1	paig status

Optional Configuration ¶

Trust3 provides overlay configuration. Trust3 will use the default configuration provided in the default_config.yaml file. This default configuration can be overridden by the user-provided custom configuration. You can provide the custom configuration in the following ways:

1. Create a new directory in the present working directory of the project with the name custom-conf.
2. Create a new custom configuration file named <env>_config.yaml(e.g. dev_config.yaml) in the custom-conf folder which will override default_config.yaml.

3. In a custom configuration file, the user should provide new configuration key values or override the existing configuration.
   Example: custom-conf/dev_config.yaml

   YAML
   1 2 3 4 5 6	database: url: "sqlite+aiosqlite:///db/database.db" security: basic_auth: secret: "<your_secret>"

   Note - If you want to create new secret, please follow the steps mentioned in How to create new password secret

How to create new password secret¶

To create a new password secret, please run below python code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

from passlib.context import CryptContext
import re


pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")


def validate_password(value):
    pattern = r'^$|^(?=.*[A-Za-z])(?=.*\d).{8,255}$'
    regex = re.compile(pattern)
    if regex.fullmatch(value):
        return True
    else:
        return False


def get_password_hash(password):
    return pwd_context.hash(password)


if __name__ == "__main__":
    password = input("Enter new password: ")
    if validate_password(password):
        hash_password = get_password_hash(password)
        print(f"New secret: {hash_password}")
    else:
        print("Password should contain. One letter, One number and at least 8 characters long.")