| Both sides previous revision Previous revision Next revision | Previous revision |
| indigo_2024.1_documentation:plugin_testing_tutorial [2024/10/18 15:04] – [Plugin Testing Guide] davel17 | indigo_2024.1_documentation:plugin_testing_tutorial [2024/10/21 18:51] (current) – [Folder Structure] davel17 |
|---|
| - The ''//unittest//'' library - this is a standard Python library and should be already available. | - The ''//unittest//'' library - this is a standard Python library and should be already available. |
| - The ''//python-dotenv//'' library - used for creating and managing Python environment variables. | - The ''//python-dotenv//'' library - used for creating and managing Python environment variables. |
| - An IDE that supports unit testing - which not required, having an IDE that supports unit testing can be very helpful. | - An IDE that supports unit testing - while not required, having an IDE that supports unit testing can be very helpful. |
| |
| === Testing Structure === | === Testing Structure === |
| |
| === Environment Variables === | === Environment Variables === |
| While optional, it is a good idea to create an environment variable framework that allows you to create and make references to elements of your development environment. Once you have installed ''//python-dotenv//'', create a ''//.ENV//'' file at the ''//Server Plugin//'' level of your plugin (or other location that Indigo's environment path search will find it). It is a plain text file. The advantage of using an environment file is that it is a great place to store references that are unique to your system and -- for shared development -- each developer can have their own individual environment. **<color #ed1c24>IMPORTANT!</color> Remember to add the ''//.ENV//'' file to your ''//.gitignore//'' list.** | While optional, it is a good idea to create an environment variable framework that allows you to create and make references to elements of your development environment. Once you have installed ''//python-dotenv//'', create a ''//.ENV//'' file at the ''//Server Plugin//'' level of your plugin (or another location that Indigo's environment path will search). It is a plain text file. The advantage of using an environment file is that it is a great place to store references that are unique to your system and -- for shared development -- each developer can have their own individual environment. **<color #ed1c24>IMPORTANT!</color> Remember to add the ''//.ENV//'' file to your ''//.gitignore//'' list.** |
| |
| .ENV file | .ENV file |
| |_ ... | |_ ... |
| </code> | </code> |
| Of course, you can put them anywhere that your plugin can see them. Depending on your development environment, you may also want to add the ''//Tests//'' folder to your ''//.gitignore//'' file to reduce the footprint of your published plugin. | Of course, you can put them anywhere your plugin can see them. Depending on your development environment, you may also want to add the ''//Tests//'' folder to your ''//.gitignore//'' file to reduce the footprint of your published plugin. |
| |
| === Main Plugin === | === Main Plugin === |