tik_manager4.objects.main

Main Module for the Tik Manager

Classes

Main

Main Tik Manager class. Handles User and Project related functions.

ReleaseObject

Data class for the update object.

Module Contents

class Main(common_folder=None)

Main Tik Manager class. Handles User and Project related functions.

add_project_as_structure_template(template_name=None)

Add the current project as a new structure template.

can_set_project(absolute_path) tik_manager4.core.constants.ValidationResult

Check if the project is valid.

Args:

absolute_path (str): The absolute path to the project.

Returns:

object: ValidationResult object.

collect_template_paths()

Collect all template files from common, project and user folders.

Returns:

list: [project_templates, common_templates, user_templates]

create_project(path, structure_template='empty', structure_data=None, set_after_creation=True, locked_commons=True, **kwargs)

Create a new project.

Args:

path (str): The path to create the project. structure_template (str): The name of the structure template to use. structure_data (dict): The structure data to use. If not provided,

The structure template name will be used to get the data from the common database.

set_after_creation (bool): If True, the project

will be set after creation.

locked_commons (bool): If True, the project will be locked to the

current commons.

Returns:

int: 1 if successful, -1 if not.

fallback_to_default_project()

Fallback to the default project.

get_latest_release()

Get the latest release version from the github repository.

Returns:

ReleaseObject: Release object with version and download links.

get_management_handler(platform_name=None)

Resolve the management handler.

Args:
platform_name (str, optional): The name of the platform.

if the platform name is not matching to the current one, a new handler will be created.

get_template_names()

Get the names of the templates.

get_template_path_by_name(name)

Gets the template file by name.

Resolution order is project > common > user.

Args:

name (str): Name of the template.

Returns:

tuple: Dcc Name, Path to the template file.

globalize_management_platform()

Globalize the management platform.

set_project(absolute_path)

Set the current project.

Args:

absolute_path (str): The absolute path to the project.

Returns:

int: 1 if successful, -1 if not.

dcc
log
class ReleaseObject(github_dict)

Data class for the update object.

Get all the links in a dictionary.

Returns:

dict: Dictionary with the link names and the links.

property debian_installer
Get the linux installer download url.
Returns:

str: The download url or None.

property is_newer
Check if the current version is newer than the installed version.
property mac_installer
Get the mac installer download url.
Returns:

str: The download url or None.

property name
Get the name.
property redhat_installer
Get the linux installer download url.
Returns:

str: The download url or None.

property release_notes
Return the release notes.
property tarball
Return the tarball.
property version
Get the version.
property windows_installer
Get the windows installer download url.
Returns:

str: The download url or None.

property zipball
Return the zipball.