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!

Splunk Answers Content Calendar, June Edition

Get ready for this week’s post dedicated to Splunk Dashboards! We're celebrating the power of community by ...

What You Read The Most: Splunk Lantern’s Most Popular Articles!

Splunk Lantern is a Splunk customer success center that provides advice from Splunk experts on valuable data ...

See your relevant APM services, dashboards, and alerts in one place with the updated ...

As a Splunk Observability user, you have a lot of data you have to manage, prioritize, and troubleshoot on a ...