Splunk Dev

How to package external python libraries required by a custom Splunk app?

boris
Path Finder

My splunk app requires external python libraries.

On my own system I can install these.

However, now I want to package my app for other Splunk users.

What is the standard way to handle the required installation of new python libraries when packaging a Splunk app for others to use?

Labels (2)
Tags (2)

stricaud_splunk
Splunk Employee
Splunk Employee

What I do is:
1) If the app requires lots of libraries (which seems to be your case), a README, or requirements.txt will do. I require people to install the dependencies before using the App. Just like any software.
2) If the libraries are small, I embed them. This way I guarantee the behavior. With new app update, libraries are updated.

rsathish47
Contributor

2nd option , how do we do that? how to embed the py lib in app. please guide me here

0 Karma

umairahmad3985
Path Finder

Just put the library folder in your Splunk App's bin folder and that way you can access it in your app code via import statements.

0 Karma

thomrs
Communicator

This is the approach I am taking as well.

0 Karma

rsathish47
Contributor

2nd option , how do we do that? how to embed the py lib in app. please guide me here

0 Karma

asieira
Path Finder

Option 1 is not available for Splunk Cloud users, is it?

0 Karma
Get Updates on the Splunk Community!

New Year, New Changes for Splunk Certifications

As we embrace a new year, we’re making a small but important update to the Splunk Certification ...

[Puzzles] Solve, Learn, Repeat: Unmerging HTML Tables

[Puzzles] Solve, Learn, Repeat: Unmerging HTML TablesFor a previous puzzle, I needed some sample data, and ...

Enterprise Security (ES) Essentials 8.3 is Now GA — Smarter Detections, Faster ...

As of today, Enterprise Security (ES) Essentials 8.3 is now generally available, helping SOC teams simplify ...