PACKAGING

FalconPy package release cycle

There are two Python packages for the CrowdStrike FalconPy project, development and production.

These packages are released on a regular cadence based upon the code review and testing cycle currently in place for this repository.

Process overview

Development Package (crowdstrike-falconpy-dev)

The development package for FalconPy is released from the dev branch as part of the code review and testing process. Depending on the nature of the changes undergoing testing, there may be several development packages released.

The module name for the crowdstrike-falconpy-dev package is falconpydev.
Example: from falconpydev import Hosts

These packages will loosely follow the Semantic Versioning Specification (SemVer) for specifying versions, with the final release aligning to the version for the next release of the production package.

Due to differences between SemVer and PEP 440, pre-release version numbers will not be SemVer compliant.

Example

Package

Version number

Current production version

1.0.1

Development package 1 (pre-release)

1.0.2.dev1

Development package 2 (pre-release)

1.0.2.dev2

Development package (release)

1.0.2

A bleeding edge / development build announcement is posted to the Show and Tell section of the discussion board for each published release of a final development package build.

Development Package bleeding edge releases

Similar to the production package, there are bleeding edge releases for the development package. Typically these are used to confirm package integrity and are deployed immediately before a development release. Bleeding edge packages are published to the test PyPI package index. Developers are welcome to test using the development bleeding edge release, but it is not recommended. The publishing of these packages will be followed up almost immediately by a package deployment to the production PyPI package index.

Please note: Bleeding edge packages published to the test PyPI package index are periodically deleted en masse.

Production Package (crowdstrike-falconpy)

After a second round of code review and testing has successfully been completed, updates are merged to the main branch of this repository. Shortly afterwards, a bleeding edge package will be released to the test PyPI package index. Developers are encouraged to leverage the bleeding edge build to perform local testing before upgrading to the latest version. After a period of time used for soak and acceptance testing (specified in the development build announcement), the production package for FalconPy is released to the production PyPI package index. All production versions of FalconPy strictly follow SemVer for version specification.