1. Installing, Running, and Packaging PrivacyFlash Pro
You can install and run PrivacyFlash Pro from the packaged release or from the source files. You can also create a new packaged version of PrivacyFlash Pro.
Running
Using PrivacyFlash Pro’s directory navigation, navigate to your iOS Swift project directory (the directory that contains your .xcodeproj
), and click OK to start the analysis. Depending on the size of your codebase, the analysis results should be available within a minute. You will now be guided through a wizard. Once you have finalized the wizard questionnaire, you can export the privacy policy for your app.
You can test PrivacyFlash Pro on the projects in the iOS-sample-projects. For example, you can analyze the AdColony sample project. Start PrivacyFlash Pro, in your browser navigate to the AdColony directory using PrivacyFlash Pro’s directory navigation, and click OK to start the analysis. The analysis results should be available within a minute.
If your browser does not connect to the localhost, try disabling any antivirus software (e.g., eset) that you may be running.
PrivacyFlash Pro analyzes iOS app source code in Swift and its integrated third party libraries in Swift and Objective-C. The library analysis works for uncompiled and compiled libraries. PrivacyFlash Pro does not analyze iOS app source code in Objective-C.
Packaging
You can also create a new packaged version of PrivacyFlash Pro. After successfully installing and running from source, run python3 package.py
within the privacyflash-pro/policygenerator
directory. A zipped file containing a macOS distributable app will be generated in the privacyflash-pro/policygenerator/dist
directory.
Note: If you are using a Python virtual environment, as we recommend, run python3 package.py
after activating the environment.
Note: If packaging for public distribution, remember to update the version number in privacyflash-pro/policygenerator/interface/index.html
and privacyflash-pro/policygenerator/package.py
. Also, please identify to your users that you packaged the version and that the version is not official.
If you experience errors packaging or running the packaged app, try updating the dependency pyinstaller
by running pip3 install pyinstaller -U
and then run the packaging script again.
2. Demo Video
3. Get Involved
PrivacyFlash Pro is from the people for the people. Everyone can contribute. In particular, feel free to open a pull request to add additional privacy practices and third party libraries. If you have other ideas or feedback, let us know. We are looking forward to hear from you!
4. Testing
Our unit tests for PrivacyFlash Pro have been built with the Python unittest framework. In order to run the built-in tests for PrivacyFlash Pro, use python3 -m unittest
from within the root directory of your local copy of this repo.
6. Third Party Libraries
PrivacyFlash Pro uses the following third party libraries. We thank the developers.
- Animate.css
- Bootstrap
- Dark Mode Switch
- pywebview
- Google Fonts Quicksand
- jQuery
- PyYAML
- Six
- Smooth Scroll
- smooth-scroll-into-view-if-needed
##