Installation Upgrades and Removal

Installation, Upgrades & Removal

FalconPy leverages the Python Package Index for distribution, making installation and maintenance easy. There are two packages for FalconPy, the production package crowdstrike-falconpy (also referred to as the 'stable release'), and the development package crowdstrike-falconpy-dev.

• Production Package (crowdstrike-falconpy)
• Development Package (crowdstrike-falconpy-dev)

Production Package

For most developer scenarios, the production package will be the preferred solution.

• Stable release
• Stable release upgrades
• Bleeding Edge release
• Bleeding Edge upgrades
• Uninstallation

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

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

Installing the Bleeding Edge release

The Bleeding Edge release is the latest release of the production package after new changes but prior to the release of this package to the production index. The period of time between the Bleeding Edge release and the production release is referred to as soak time and typically lasts for a few days to a week. If you'd like to try the Bleeding Edge version of the stable release, 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 to the Bleeding Edge release

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.

---

Development package

The FalconPy development package (crowdstrike-falconpy-dev) is released from the dev branch as part of the code review and testing process. New library functionality and changes will be released to the development package prior to the production package and are available for pre-release testing.

• Development release
• Development release upgrades
• Uninstallation

Installing the development release

python3 -m pip install crowdstrike-falconpy-dev

You may also call pip3 directly to perform an installation:

pip3 install crowdstrike-falconpy-dev

Upgrading to the most recent development release

You can upgrade to the latest release by installing updates via the Python Package Index.

python3 -m pip install crowdstrike-falconpy-dev --upgrade

or

pip3 install crowdstrike-falconpy-dev --upgrade

Uninstalling and removing the development package

To uninstall and remove the FalconPy development package entirely:

python3 -m pip uninstall crowdstrike-falconpy-dev

or:

pip3 uninstall crowdstrike-falconpy-dev