prerna.engine.api.IVenvEngine Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of semoss Show documentation

SEMOSS

The newest version!

package prerna.engine.api;

import java.util.List;
import java.util.Map;

public interface IVenvEngine extends IEngine {
	
	String VENV_TYPE = "VENV_TYPE";
	
	VenvTypeEnum getVenvType();
	
	/*
	 * List all packages and the respective versions	
	*/	
	List> listPackages() throws Exception;

	/*
	 * Pull the requirements file from a remote repo using git
	*/	
	void pullRequirementsFile();
	
	
	/*
	 * Instead of pulling a requirements file let it be uploaded
	*/	
	void uploadRequirementsFile(String filePath);
	
	/*
	 * The actual process implementation to create the virtual environment and install the relevant packages
	*/	
	void createVirtualEnv() throws Exception;
	

	
	/*
	 * The requirements file has been updated and needs to be re-pulled
	*/	
	void updateVirtualEnv();
	
	
	/*
	 *  Add a package to the venv. Restricted for Admins only
	*/	
	void addPackage(Map parameters) throws Exception;
	
	
	/*
	 *  Remove a package to the venv. Restricted for Admins only
	*/	
	void removePackage(Map parameters) throws Exception;
	
	
	/*
	 *  Get the path to the venv executable
	*/	
	String pathToExecutable();
}