Home

izpay

izpay(path: str = Option(os.getcwd, '--path', '-p', help='Path to the IzPay flutter project', hidden=True), flavor: str = Option('', '--flavor', '-f', help='Flavor name'), cd: bool = Option(False, '--cd', '-c', help='Mark if the command is running in a CD environment', hidden=True))

Change the flavor of the IzPay Flutter application.

This command is used to change the flavor of the IzPay Flutter application to a specified flavor. It includes updating various configuration files and settings to match the chosen flavor.

• path (str): The file system path to the root of the IzPay Flutter project. Defaults to the current working directory.
• flavor (str): The name of the flavor to switch to. If not provided, the user will be prompted to choose from available flavors.

Raises: - ValueError: If the command is not run from within a IzPay Flutter application directory. - Exit: If the specified flavor is not found among the available flavors.

The command performs several actions: - Validates the current directory to ensure it's a IzPay Flutter app. - Retrieves and lists available flavors from the 'envs' folder. - Prompts the user to select a flavor if not provided as an argument. - Updates Android settings (Gradle), app icon, OneSignal icons, and Firebase settings based on the selected flavor. - Sets up environment files corresponding to the new flavor.

Upon successful execution, it updates the app to use the specified flavor.

loyaltyFlavor

loyaltyFlavor(path: str = Option(os.getcwd, '--path', '-p', help='Path to the Loyalty flutter project', hidden=True), flavor: str = Option('', '--flavor', '-f', help='Flavor name'))

Change the flavor of the Loyalty Flutter application.

This command is used to change the flavor of the Loyalty Flutter application to a specified flavor. It includes updating various configuration files and settings to match the chosen flavor.

• path (str): The file system path to the root of the Loyalty Flutter project. Defaults to the current working directory.
• flavor (str): The name of the flavor to switch to. If not provided, the user will be prompted to choose from available flavors.

Raises: - ValueError: If the command is not run from within a Loyalty Flutter application directory. - Exit: If the specified flavor is not found among the available flavors.

The command performs several actions: - Validates the current directory to ensure it's a Loyalty Flutter app. - Retrieves and lists available flavors from the 'envs' folder. - Prompts the user to select a flavor if not provided as an argument. - Updates Android settings (Gradle), app icon, OneSignal icons, and Firebase settings based on the selected flavor. - Sets up environment files corresponding to the new flavor.

Upon successful execution, it updates the app to use the specified flavor.

new_entity

new_entity(path: str = Option('', '--path', '-p', help='Path to the project', hidden=True), entityName: str = Option('', '--name', '-n', help='Entity name'), solutionName: str = Option('', '--project', '-o', help='Project name'), projectName: str = Option('', '--project-name', '-n', help='Project name'))

Create a new Entity in the .NET project

This command is used to create a new entity in the .NET project. It includes creating a new class file and adding it to the project.

• path (str): The file system path to the root of the .NET project. Defaults to the current working directory.
• name (str): The name of the entity to create. If not provided, the user will be prompted to enter the name.

Raises: - FileNotFoundError: If the command is not run from within a .NET project directory. - ValueError: If the specified entity name is not provided.

new_module

new_module(path: str = Option('', '--path', '-p', help='Path to the flutter project', hidden=True), module: str = Option('', '--module', '-m', help='Module name'))

Create a new module within a Flutter project.

This command prompts the user to select or create a new module for a specified Flutter project. It also provides an option to create a new page in the module after creation.

Attributes:

Name	Type	Description
path	str	The path to the Flutter project. If left empty, the user will be prompted.
module	str	The name of the module to create. If left empty, the user will be prompted.

Examples:

izio new-module --module "my Module"
{create a new module in the flutter project called "my_module"}

new_page

new_page(path: str = Option('', '--path', '-p', help='Path to the flutter project', hidden=True), module: str = Option('', '--module', '-m', help='Module name'), page: str = Option('', '--page', '-p', help='Page name'))

Create a new page within a module of a Flutter project.

This command allows the creation of a new page in a specified module of a Flutter project. If module or page names are not provided, the user will be prompted.

Args:

path (str): The path to the Flutter project. If left empty, the user will be prompted.
module (str): The name of the module where the page will be created. If left empty, the user will be prompted.
page (str): The name of the page to be created. If left empty, the user will be prompted.

Examples:

izio createpage --module "my_module" --page "my_page"

new_project

new_project(path: str = Option('', '--path', '-p', help='Path to the flutter project', hidden=True), type: str = Option('', '--type', '-t', help='Type of the project (flutter, netCore)'), solution: str = Option('IzPay', '--solution', '-s', help='What is the solution you are working on, like: Mangos, Loyalty, IzPay, etc'), projectName: str = Option('', '--project-name', '-n', help='Name of the project'), platforms: str = Option('', '--platforms', '-l', help='Platforms'), description: str = Option('', '--description', '-d', help='Description of the project'))

Create a new Izio project of either Flutter or .NET type. This command initializes a new project, allowing the user to specify various details like project name, type, platforms, and description. The project type can be either Flutter or .NET.

Attributes:

Name	Type	Description
path	str	The path where the project will be created. If left empty, the user will be prompted.
type	str	The type of the project ('flutter' or 'netCore'). If left empty, the user will be prompted.
solution	str	The solution name for the project. Default is 'IzPay'.
projectName	str	The name of the project. If left empty, the user will be prompted.
platforms	str	The platforms for the Flutter project (e.g., 'android,ios,web').
description	str	A description of the project. If left empty, the user will be prompted.

Examples:

izio new-project -n "my_project" -s IzPay -d "my description" -p "path/to/project" -l "android,ios,web"
{create a new flutter project in Mb.IzPay.flutter.my_project for android, ios, web}

izio new-project -t netCore -n "my_dot_det_project" -s IzPay -d "my description" -p "path/to/project" -l "android,ios,web"
{create a new flutter project in Be.IzPay.netCore.my_dot_det_project for android, ios, web}