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
Got questions? Get answers!

Join the Splunk Community Slack to learn, troubleshoot, and make connections with fellow Splunk practitioners in real time!

Meet up IRL or virtually!

Join Splunk User Groups to connect and learn in-person by region or remotely by topic or industry.

Get Updates on the Splunk Community!

Persistent Queue at TcpOut — One of Splunk's Most Practical Features

Splunk introduced persistent queueing at the tcpout layer as one of the most practical resilience features in ...

Skip the Awkward Silence: Have a .conf-ersation at .conf26

Picture this. You arrive at .conf26 already having your socializing and networking plans mapped out. No ...

Rethinking Zero Trust: From Product Purchases to Logical Control Evidence

Implementing Zero Trust (ZT) across complex environments often falters at the very beginning due to a ...