IronMesh Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== User Guide ======

In this short guide, I will tell you how to prepare your operation system for [[en:products:pussy:concepts:manager|Manager]] launching, and also I'll tell you how to use it and install 3rd party plugins. This guide is intended for users without programming skills.

===== Step 1. Install Python and PySide6 =====

Since PUSSY is supplied as source code, an Python interpreter is needed to run it. To do this, go to the website [[http://python.org/downloads|python.org]] and download the distribution package for your operating system. Next, I will describe the installation process for Windows.

After downloading, run the executable file and mark the "Add Python 3.6 to the PATH" field, as shown in the figure (this may look different depending on the version you are installing).

{{ :products:pussy:screenshots:python-installation-options.png?473x296 }}

Click **Install Now** to start the installation immediately or **Customize installation** to fine-tune the installation.

After installing Python, you need to install the PySide6 package. To do this, launch the Command Prompt application by pressing //Win+R //and type //cmd //and press **Enter**, a terminal window should appear, then enter the command:

<code bash>
pip install PySide6
</code>

After downloading the package, the application is ready to launch.

<WRAP center round info 60%>

The suit is developed and tested on **Python 3.11**, so I recommend using this version or a newer one.

</WRAP>

===== Step 2. Downloading the source code and launching =====

Go to [[https://github.com/iron-mesh/utilities-box|GitHub Repository]] to download or look for additional download methods on [[https://ironmesh.ru/en/products/24-applications/67-pussy|Project page]]. On GitHub, click on the "Code" button and select **Download ZIP** or download the source archive in the //Release section//. After downloading, unpack the contents on your PC. Double-click the **PUSSY.pyw** file in the **PUSSY/manager** folder.

{{ :products:pussy:screenshots:2023-11-24_22_13_32-iron-mesh_utilities-box_python_utilitarian_script_system_for_you_mozilla_fire.jpg?400&nolink |downloading sources from GitHub}}

===== Step 3. Use =====

PluginsIf all the previous steps were performed correctly, the main window of the Manager will appear on the screen. The main window will display the tabs of the Plug-ins that are currently installed and activated. By default, **Plugins** are initialized after the tab is activated, if you need to initialize it at startup, then you will be told how to do this.

To go to the list of installed plugins, press //Ctrl+Alt+P//. The first column shows the names of the Plug-ins; the second shows the activation status buttons, with which you can turn plug-ins off or on at any time; the third shows the buttons to go to settings, if the button is not active, then there are no settings; the fourth shows additional options: //Plugin Info// - information about a plugin; //Reset Settings// - reset settings; //Initialize on startup// - initialize a plugin at startup.{{ :products:pussy:screenshots:2023-09-17_14_09_54-pussy.jpg?400 |2023-09-17_14_09_54-pussy.jpg}}

The **Manager **has a small list of settings, to access them you need to press //Ctrl+Alt+S. // The first section contains settings for configuring the interface, it makes no sense to describe each of them, since their purpose should be clear. In the second section, there is one option: "//External plugin directories//" - this is a list of folders where the **Manager **searches for plugins, we will talk about them later. To apply the settings, click on **Apply settings**. The **Delete invalid data**// //button //- // deletes data of plugins that have been deleted or are unavailable.

{{ :products:pussy:screenshots:2023-09-17_14_50_31-pussy.jpg?400&direct }}

There is another section that most likely won't be interesting for regular users, but in some cases it can be useful, for example, if a plugin is not working correctly. We are talking about system messages, to go to them you need to press //Ctrl+Alt +L//,  information about the operation of plug-ins is displayed there, if the messages are highlighted in green, then everything is fine, if in red, then an exception occurred during operation. To display detailed information about exceptions, select the option //**Display error info in Logs**// in the settings.

===== Step 4. Installing, removing plugins =====

<WRAP center round info 60%>

[[en:products:pussy:concepts:plugin]] - in fact, it is a package (based on Python terminology), it is a folder with files that contain the source code, and it must contain a file named //_ _init_ _.py//.

</WRAP>


In order to install the plugin, you just need to copy the source code folder to the **PUSSY/manager/Plugins** directory, or to any other folder specified in the settings under "External plugin directories".

Deleting is performing in the same way. After installing or deleting it, restart the **Manager **so that the changes take effect. To delete service information of deleted plugins, click on **Delete invalid data**  in the settings section.

To learn how to develop your own plugins, see the relevant materials on this website.