FAQ
Thank you for your interest in NB Defense. We want to make tools with the community that data scientist and engineers can use and enjoy. Welcome to the community!
Common Questions
Why should I use NB Defense as a data scientist?
We know that JupyterLab is where many data scientist experiement and prove out their ideas. The NB Defense JupyterLab Extension and CLI allows you to check for vulnerabilities and security issues before the code leaves your environment. You can use NB Defense to check for personally identifiable information, secrets, common exposures and vulnerabilites, and non permissive licenses with the click of the button. We wanted to create a way for data scientists to reduce exposure to security issues and save time later on, by integrating good security practices into the development process.
Can I run NB Defense in my CI pipeline?
Yes, you can run NB Defense in your CI pipline using the NB Defense CLI! Use the CLI in your CI pipelines to scan repositories, or multiple notebooks at a time.
What is special about NB Defense when many security tools offer similar functionality?
NB Defense is special because it allows you to scan Jupyter Notebooks. We provide both a JupyterLab Extension that you can use to scan notebooks while you're working, and a CLI that you can use to scan groups of notebooks or repositories. Using both of these tools, you can scan your notebooks for personally identifiable information (PII), secrets, common exposures and vulnerabilities (CVEs), and non permissive licenses.
Does NB Defense JupyterLab Extension run in my kernel?
We recommend that you isolate NB Defense from the kernel that you are using for your notebook. If you have installed NB Defense into a separate python environment, it will not run in your kernel. We do use your active kernels python path to determine which third party dependencies are installed, so we can scan them for CVEs and licenses.
Found A Bug? 🐞
Found an issue with the NB Defense CLI or JupyterLab Extension? Lets get that fixed. Let us know what you've found by opening an issue using the following links:
Found An Issue With Our Documentation? 📄
We want to be clear, correct, and concise. Let us know where we can improve:
Have An Idea For A New Feature? 💡
We'd love to hear about it. Tell us more by creating an issue below:
Have A Question? ❓
Feel free to ask questions using github discussions by following the links below: