Including python wheels

Sometimes the python packages (wheel, .whl) aren't available in pypi or any private repository for the installation process. KSDK apps allow the user to add .whl files to the application that will be installed during the app building process.

To add a wheel and the associated dependecy to the application, follow the steps bellow:

  • After creating the application, copy the .whl to the wheels folder. The wheel's name must follow the python whl file format

  • Add the dependency to the requirements.txt file, for example some-package==1.0. The building process will try to find the links to the dependecy source wheel.

my-app                                                                                                                                                                                                                                           
├── app.yaml                                                                                                                                                                                                                                              
├── build                                                                                                                                                                                                                                        
├── datatype                                                                                                                                                                                                                                             
├── docs   
└── my_app
    ├── __init__.py                                                                                                                                                                                                                                       
    └── my_app.py                                                                                                                                                                                                                                        
├── requirements.txt
└── wheels                                                                                                                                                                                                                                       
    └── some-package-1.0-py3-none-any.whl
└── setup.py