Deploy-Helper

Description

Deploy Helper is designed to help developers during application releases. Many times to create the release package to be copied to the servers, it is necessary to copy many files (compiled project files such as .dll, etc.) which can be located on various different locations and this can be time consuming.

So, the idea was born to solve this problem, creating a software where you can extensively configure and save your deployments (in an xml file) and execute them at any time with just one click. For now the software allows the creation, saving and execution of the deploy (copy of the files) but the next functions in addition to the modification and deletion of the deployments will be more advanced such as linking documents to deployments, scheduling of deployments, execution of other custom tasks related to deployment (such as query on the db), etc.

Obviously Deploy Helper isn't just for programmers, it can be used by anyone who needs to copy the same files often.

How it work

The software work with an xml file which is easy to understand and modify. In fact, you can modify the xml file even outside the program (with any editor) by adding, modifying or deleting the "deploy" nodes that will then be read by the program. The structure of the xml is really simple. Below an example:

<xml>
	<deploys>
		<deploy name="test_deploy">
			<sourceFilePath>C:/xampp/htdocs/index.php</sourceFilePath>
			<sourceFilePath>C:/xampp/htdocs/favicon.ico</sourceFilePath>
			<sourceFilePath>C:/xampp/htdocs/applications.html</sourceFilePath>
			<sourceFilePath>C:/xampp/htdocs/bitnami.css</sourceFilePath>
			<destinationPath>C:/xampp/htdocs/xampp</destinationPath>
		</deploy>
		<deploy name="test_deploy2">
			<sourceFilePath>C:/xampp/htdocs/bitnami.css</sourceFilePath>
			<destinationPath>C:/xampp/htdocs/xampp</destinationPath>
		</deploy>
	</deploys>
</xml>

Dark Theme:

Light Theme:

To-Do:

✔️ Deploy saving

✔️ Deploy execution

✔️ Dark and light themes

❌ Functionality to modify the deploy

❌ Functionality to delete the deploy

❌ Progress bar for large files

❌ Linking of documents to deploys

❌ Adding other customs tasks to execute during deployment

How to Use

If you want to try the software and you are using Windows, just download the 'dist' folder and run main.exe.

If you want to download and modify the project, fork this repository and follow the instructions below for the configuration.

Configuration and Requirements

• Python 3.x and pyqt5 are required to run the project.

• To install PyQt5, PyQt5-tools, QtDesigner and PyUIC you can see this tutorial: https://pythonpyqt.com/how-to-install-pyqt5-in-pycharm/

⚠️ Note that the path of the qt designer can be very different so you will have to be patient to find it. In my case the path was this: C:\Users*MyUser*\AppData\Roaming\Python\Python39\site-packages\qt5_applications\Qt\designer.exe

Build (.exe)

To build the project as single .exe file you can use PyInstaller.

Intall it with: pip install pyinstaller

To start compiling the project in a single .exe file use the following command: pyinstaller.exe --onefile --windowed main.py

⚠️ Note: If you get the following error: "C:\Users\username>pyinstaller 'pyinstaller' is not recognized as an internal or external command, operable program or batch file.":

• Find the path of pyinstaller.exe, in my case it's: "C:\Users<user>\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.9_qbz5n2kfra8p0\LocalCache\local-packages\Python39\Scripts\pyinstaller.exe" (search it in all disk), copy pyinstaller.exe in the root directory of the project:

• Then in the terminal move to the root path of the project ( "C:\Users<user>\Desktop\DeployHelper" ) and execute command: ".\pyinstaller.exe --onefile --windowed main.py". the characters ".\" are used to make trusted the pyinstaller.exe.

Now you should have "build" and "dist" folder. In "dist" folder you have main.exe.

⚠️Remember to have in "dist" folder the file "splash.PNG" (splash screen image) and file "Deploys.xml" with this content:

<xml>
	<deploys>
	</deploys>
</xml>

License

License: MIT