Installation Upgrades and Removal

Installation, Upgrades & Removal

FalconPy leverages the Python Package Index for distribution, making installation and maintenance easy.

Installing the stable release

Stable releases of FalconPy are available on the Python Package Index and are the default installation option:

python3 -m pip install crowdstrike-falconpy

You may also call pip3 directly to perform an installation:

pip3 install crowdstrike-falconpy

Installing the Bleeding Edge version

If you'd like to try the absolute bleeding edge, an automated GitHub action releases a test package with every merged pull request that has the string [DEPLOY] in the head of the commit.

To install this Bleeding Edge (development) version, you will need to use the PyPI test index:

python3 -m pip install -i https://test.pypi.org/simple crowdstrike-falconpy

or:

pip3 install -i https://test.pypi.org/simple crowdstrike-falconpy

Upgrading

Upgrading the package to the latest stable release follows a similar pattern:

python3 -m pip install crowdstrike-falconpy --upgrade

or:

pip3 install crowdstrike-falconpy --upgrade

Upgrading to the Bleeding Edge version

To upgrade to the Bleeding Edge version you can use the following command:

python3 -m pip install -i https://test.pypi.org/simple crowdstrike-falconpy --upgrade

or:

pip3 install -i https://test.pypi.org/simple crowdstrike-falconpy --upgrade

Uninstalling and removing the package

To uninstall and remove the FalconPy package entirely:

python3 -m pip uninstall crowdstrike-falconpy

or:

pip3 uninstall crowdstrike-falconpy

Please note: This will uninstall whichever version of FalconPy you have installed, bleeding edge or stable.