Skip to content

Commit

Permalink
Packaging updates, Licensing fixes and minor README cleanup (#7)
Browse files Browse the repository at this point in the history
* Package layout updates

* Package updates

* Cleaning up tabs

* README and LICENSE updates

* More package testing
  • Loading branch information
jshcodes authored Dec 7, 2020
1 parent ac7b751 commit 3a37fc2
Show file tree
Hide file tree
Showing 26 changed files with 512 additions and 566 deletions.
45 changes: 21 additions & 24 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,27 +1,24 @@
Copyright CrowdStrike 2020
This is free and unencumbered software released into the public domain.

By accessing or using this script, sample code, application programming interface, tools,
and/or associated documentation (if any) (collectively, “Tools”), You (i) represent and
warrant that You are entering into this Agreement on behalf of a company, organization
or another legal entity (“Entity”) that is currently a customer or partner of
CrowdStrike, Inc. (“CrowdStrike”), and (ii) have the authority to bind such Entity and
such Entity agrees to be bound by this Agreement.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

CrowdStrike grants Entity a non-exclusive, non-transferable, non-sublicensable, royalty
free and limited license to access and use the Tools solely for Entity’s internal business
purposes and in accordance with its obligations under any agreement(s) it may have with
CrowdStrike. Entity acknowledges and agrees that CrowdStrike and its licensors retain all
right, title and interest in and to the Tools, and all intellectual property rights
embodied therein, and that Entity has no right, title or interest therein except for the
express licenses granted hereunder and that Entity will treat such Tools as CrowdStrike’s
confidential information.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE TOOLS ARE PROVIDED “AS-IS” WITHOUT WARRANTY OF ANY KIND, WHETHER EXPRESS, IMPLIED OR
STATUTORY OR OTHERWISE. CROWDSTRIKE SPECIFICALLY DISCLAIMS ALL SUPPORT OBLIGATIONS AND
ALL WARRANTIES, INCLUDING WITHOUT LIMITATION, ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. IN NO EVENT SHALL CROWDSTRIKE
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THE TOOLS, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <https://unlicense.org>
48 changes: 23 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,37 +42,35 @@ Currently the solution defines a class for each service (_ex: cloud_connect_aws_
## Installation
FalconPy is available on PyPI:
```bash
$ python -m pip install falconpy
$ python -m pip install crowdstrike-falconpy
```

## Documentation
Documentation can be found in the [GitHub Wiki](https://github.com/CrowdStrike/falconpy/wiki).

## License
Copyright CrowdStrike 2020
This is free and unencumbered software released into the public domain.

By accessing or using this script, sample code, application programming interface, tools,
and/or associated documentation (if any) (collectively, “Tools”), You (i) represent and
warrant that You are entering into this Agreement on behalf of a company, organization
or another legal entity (“Entity”) that is currently a customer or partner of
CrowdStrike, Inc. (“CrowdStrike”), and (ii) have the authority to bind such Entity and
such Entity agrees to be bound by this Agreement.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

CrowdStrike grants Entity a non-exclusive, non-transferable, non-sublicensable, royalty
free and limited license to access and use the Tools solely for Entity’s internal business
purposes and in accordance with its obligations under any agreement(s) it may have with
CrowdStrike. Entity acknowledges and agrees that CrowdStrike and its licensors retain all
right, title and interest in and to the Tools, and all intellectual property rights
embodied therein, and that Entity has no right, title or interest therein except for the
express licenses granted hereunder and that Entity will treat such Tools as CrowdStrike’s
confidential information.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <https://unlicense.org>

THE TOOLS ARE PROVIDED “AS-IS” WITHOUT WARRANTY OF ANY KIND, WHETHER EXPRESS, IMPLIED OR
STATUTORY OR OTHERWISE. CROWDSTRIKE SPECIFICALLY DISCLAIMS ALL SUPPORT OBLIGATIONS AND
ALL WARRANTIES, INCLUDING WITHOUT LIMITATION, ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. IN NO EVENT SHALL CROWDSTRIKE
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THE TOOLS, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Empty file removed falconpy/services/__init__.py
Empty file.
25 changes: 18 additions & 7 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
import setuptools
from setuptools import find_packages
from setuptools import setup
from glob import glob
from os.path import basename
from os.path import dirname
from os.path import splitext

with open("README.md", "r") as fh:
long_description = fh.read()

setuptools.setup(
setup(
name="crowdstrike-falconpy",
version="0.1.7",
author="CrowdStrike",
Expand All @@ -12,19 +17,25 @@
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/CrowdStrike/falconpy",
packages=["falconpy"],
package_dir={'': 'falconpy'},
packages=find_packages("src"),
package_dir={"": "src"},
py_modules=[splitext(basename(path))[0] for path in glob("src/*.py")],
include_package_data=True,
install_requires=[
"requests",
"urllib3"
"requests",
"urllib3"
],
classifiers=[
"Intended Audience :: Developers",
"Operating System :: Unix",
"Operating System :: POSIX",
"Operating System :: Microsoft :: Windows",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"License :: Other/Proprietary License",
"License :: OSI Approved :: The Unlicense (Unlicense)",
"Operating System :: OS Independent",
],
python_requires='>=3.6',
Expand Down
File renamed without changes.
File renamed without changes.
45 changes: 21 additions & 24 deletions falconpy/api_complete.py → src/falconpy/api_complete.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,30 @@
# #
# api_complete.py - All-in-one CrowdStrike Falcon OAuth2 API harness #
#####################################################################################################
# Copyright CrowdStrike 2020
# This is free and unencumbered software released into the public domain.

# By accessing or using this script, sample code, application programming interface, tools,
# and/or associated documentation (if any) (collectively, “Tools”), You (i) represent and
# warrant that You are entering into this Agreement on behalf of a company, organization
# or another legal entity (“Entity”) that is currently a customer or partner of
# CrowdStrike, Inc. (“CrowdStrike”), and (ii) have the authority to bind such Entity and
# such Entity agrees to be bound by this Agreement.
# Anyone is free to copy, modify, publish, use, compile, sell, or
# distribute this software, either in source code form or as a compiled
# binary, for any purpose, commercial or non-commercial, and by any
# means.

# CrowdStrike grants Entity a non-exclusive, non-transferable, non-sublicensable, royalty
# free and limited license to access and use the Tools solely for Entity’s internal business
# purposes and in accordance with its obligations under any agreement(s) it may have with
# CrowdStrike. Entity acknowledges and agrees that CrowdStrike and its licensors retain all
# right, title and interest in and to the Tools, and all intellectual property rights
# embodied therein, and that Entity has no right, title or interest therein except for the
# express licenses granted hereunder and that Entity will treat such Tools as CrowdStrike’s
# confidential information.
# In jurisdictions that recognize copyright laws, the author or authors
# of this software dedicate any and all copyright interest in the
# software to the public domain. We make this dedication for the benefit
# of the public at large and to the detriment of our heirs and
# successors. We intend this dedication to be an overt act of
# relinquishment in perpetuity of all present and future rights to this
# software under copyright law.

# THE TOOLS ARE PROVIDED “AS-IS” WITHOUT WARRANTY OF ANY KIND, WHETHER EXPRESS, IMPLIED OR
# STATUTORY OR OTHERWISE. CROWDSTRIKE SPECIFICALLY DISCLAIMS ALL SUPPORT OBLIGATIONS AND
# ALL WARRANTIES, INCLUDING WITHOUT LIMITATION, ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. IN NO EVENT SHALL CROWDSTRIKE
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THE TOOLS, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.

# For more information, please refer to <https://unlicense.org>

import requests
import json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,30 @@
# #
# cloud_connect_aws - Falcon X Discover API Interface Class #
################################################################################################################
# Copyright CrowdStrike 2020

# By accessing or using this script, sample code, application programming interface, tools,
# and/or associated documentation (if any) (collectively, “Tools”), You (i) represent and
# warrant that You are entering into this Agreement on behalf of a company, organization
# or another legal entity (“Entity”) that is currently a customer or partner of
# CrowdStrike, Inc. (“CrowdStrike”), and (ii) have the authority to bind such Entity and
# such Entity agrees to be bound by this Agreement.

# CrowdStrike grants Entity a non-exclusive, non-transferable, non-sublicensable, royalty
# free and limited license to access and use the Tools solely for Entity’s internal business
# purposes and in accordance with its obligations under any agreement(s) it may have with
# CrowdStrike. Entity acknowledges and agrees that CrowdStrike and its licensors retain all
# right, title and interest in and to the Tools, and all intellectual property rights
# embodied therein, and that Entity has no right, title or interest therein except for the
# express licenses granted hereunder and that Entity will treat such Tools as CrowdStrike’s
# confidential information.

# THE TOOLS ARE PROVIDED “AS-IS” WITHOUT WARRANTY OF ANY KIND, WHETHER EXPRESS, IMPLIED OR
# STATUTORY OR OTHERWISE. CROWDSTRIKE SPECIFICALLY DISCLAIMS ALL SUPPORT OBLIGATIONS AND
# ALL WARRANTIES, INCLUDING WITHOUT LIMITATION, ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. IN NO EVENT SHALL CROWDSTRIKE
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THE TOOLS, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# This is free and unencumbered software released into the public domain.

# Anyone is free to copy, modify, publish, use, compile, sell, or
# distribute this software, either in source code form or as a compiled
# binary, for any purpose, commercial or non-commercial, and by any
# means.

# In jurisdictions that recognize copyright laws, the author or authors
# of this software dedicate any and all copyright interest in the
# software to the public domain. We make this dedication for the benefit
# of the public at large and to the detriment of our heirs and
# successors. We intend this dedication to be an overt act of
# relinquishment in perpetuity of all present and future rights to this
# software under copyright law.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.

# For more information, please refer to <https://unlicense.org>

import requests
import json
Expand Down
45 changes: 21 additions & 24 deletions falconpy/services/detects.py → src/falconpy/detects.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,30 @@
# #
# detects - Falcon X Detections API Interface Class #
################################################################################################################
# Copyright CrowdStrike 2020
# This is free and unencumbered software released into the public domain.

# By accessing or using this script, sample code, application programming interface, tools,
# and/or associated documentation (if any) (collectively, “Tools”), You (i) represent and
# warrant that You are entering into this Agreement on behalf of a company, organization
# or another legal entity (“Entity”) that is currently a customer or partner of
# CrowdStrike, Inc. (“CrowdStrike”), and (ii) have the authority to bind such Entity and
# such Entity agrees to be bound by this Agreement.
# Anyone is free to copy, modify, publish, use, compile, sell, or
# distribute this software, either in source code form or as a compiled
# binary, for any purpose, commercial or non-commercial, and by any
# means.

# CrowdStrike grants Entity a non-exclusive, non-transferable, non-sublicensable, royalty
# free and limited license to access and use the Tools solely for Entity’s internal business
# purposes and in accordance with its obligations under any agreement(s) it may have with
# CrowdStrike. Entity acknowledges and agrees that CrowdStrike and its licensors retain all
# right, title and interest in and to the Tools, and all intellectual property rights
# embodied therein, and that Entity has no right, title or interest therein except for the
# express licenses granted hereunder and that Entity will treat such Tools as CrowdStrike’s
# confidential information.
# In jurisdictions that recognize copyright laws, the author or authors
# of this software dedicate any and all copyright interest in the
# software to the public domain. We make this dedication for the benefit
# of the public at large and to the detriment of our heirs and
# successors. We intend this dedication to be an overt act of
# relinquishment in perpetuity of all present and future rights to this
# software under copyright law.

# THE TOOLS ARE PROVIDED “AS-IS” WITHOUT WARRANTY OF ANY KIND, WHETHER EXPRESS, IMPLIED OR
# STATUTORY OR OTHERWISE. CROWDSTRIKE SPECIFICALLY DISCLAIMS ALL SUPPORT OBLIGATIONS AND
# ALL WARRANTIES, INCLUDING WITHOUT LIMITATION, ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. IN NO EVENT SHALL CROWDSTRIKE
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THE TOOLS, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.

# For more information, please refer to <https://unlicense.org>

import requests
import json
Expand Down
Loading

0 comments on commit 3a37fc2

Please sign in to comment.