refactor

CONTRIBUTING.md

@@ -1,6 +1,8 @@
 # Contributing to StackGuardian Policy Framework
 
 Thank you for taking the time to contribute! 🎉
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
 
 The following is a set of guidelines for contributing to StackGuardian Policy Framework on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
 
@@ -14,6 +16,12 @@ We use GitHub issues to track bugs at [https://github.com/stackguardian/policy-f
 
 All contributions to solve GitHub issues tagged with "bug", "enhancement" and "help wanted" are most welcome and greatly appreciated.
 
+### Documentation
+
+StackGuardian Policy Framework could always use more documentation, whether as part of the
+official StackGuardian Policy Framework docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
 ### Submit Feedback
 
 Please use GitHub Discussions to submit feedback and engage with community [https://github.com/StackGuardian/feedback/discussions/8](https://github.com/StackGuardian/feedback/discussions/8).

MANIFEST.in

@@ -0,0 +1,25 @@
+include *.lock
+include *.md
+include Pipfile
+recursive-include ci *.gitkeep
+recursive-include cli *.sh
+recursive-include policies *.json
+recursive-include resources *.JPG
+recursive-include resources *.conf
+recursive-include resources *.css
+recursive-include resources *.dockerignore
+recursive-include resources *.ico
+recursive-include resources *.js
+recursive-include resources *.json
+recursive-include resources *.md
+recursive-include resources *.svg
+recursive-include resources Makefile
+recursive-include src *.json
+recursive-include src *.md
+recursive-include src *.new
+recursive-include src *.old
+recursive-include src *.py
+recursive-include src *.rego
+recursive-include tests *.json
+
+global-exclude *.py[cod] __pycache__/* *.so *.dylib

setup.py

@@ -13,6 +13,7 @@
 
 from setuptools import find_packages
 from setuptools import setup
+from setuptools.command.install import install
 
 
 def read(*names, **kwargs):
@@ -21,6 +22,11 @@ def read(*names, **kwargs):
     ) as fh:
         return fh.read()
 
+class CustomInstall(install):
+    def run(self):
+        install.run(self)
+        # custom stuff here
+        print("This is some custom stuff.")
 
 setup(
     name="sg_policy",
@@ -71,7 +77,7 @@ def read(*names, **kwargs):
         "Issue Tracker": "https://github.com/stackguardian/policy-framework/issues",
     },
     keywords=["iac", "policy", "terraform", "policy as code"],
-    python_requires="==3.8.*",
+    python_requires=">=3.8.*",
     install_requires=["simplejson==3.17.2"],
     extras_require={
         # eg:
@@ -86,4 +92,5 @@ def read(*names, **kwargs):
             "sg_policy=sg_policy.__main__:main",
         ]
     },
+    cmdclass={'install': CustomInstall}
 )