ModtoolsImage

A simple, multi-user image moderation platform for Trust & Safety professionals

What is Modtools Image?

Modtools Image is a simple, multi-user image moderation platform for Trust & Safety professionals. It has the capacity to receive images and associated metadata through a JSON web service, to scan them using one or more specified vendor APIs, and to initiate follow-up actions. Both the scanning APIs and the actions use an extensible plugin architecture.

Image moderation dashboard

Includes a basic image moderation dashboard for human review and actioning of submitted images. Actions available to moderators through the dashboard are fully configurable.

Smart filtering

Filter images based on metadata such as the results of automatic scans. Moderators only need to spend their time reviewing images already identified as suspicious.

Headless mode

Can also be run in a server-only mode for automatic scanning and actioning of images that match a defined threshold or event, with the ability to query actions taken.

Extensible plugin architecture

Out of the box, comes with integration of support for Hive AI image classification, PhotoDNA hash scanning, email alerting, and reporting to NCMEC (own credentials required).

Multi-user capable

User authentication leverages Flask-Login. Admins can invite, promote, degrade, or remove users, maintaining robust control over who can access the system.

Permissive license

Built on Flask, and licensed under the permissive MIT license. Integrate it into your own systems without the risk of being required to share your own proprietary code.

Screenshot

Get Started

Clone the repository


git clone https://github.com/qirtaiba/modtools
                     

Set up a virtual environment

    
python3 -m venv venv
source venv/bin/activate  # For Unix/Linux/MacOS
venv\Scripts\activate  # For Windows
    

Install Dependencies


pip install -r requirements.txt
                    

Or simply use Docker


docker pull qirtaiba/modtools
docker run -d --name modtools -p 8000:8000 -v $(pwd)/.env:/app/.env qirtaiba/modtools
                    

Full Documentation

For additional setup steps including setting environment variables, please consult the README file on Github.

More on GitHub

Submitting an image for scanning


curl -X POST \
  -F "Email=example@email.com" \
  -F "Password=yourpassword" \
  -F "image=@/path/to/your/image.jpg" \
  -F "metadata={\"title\":\"Example Title\", \"extension\":\"jpg\"}" \
  -F "reportee_name=John Doe" \
  -F "reportee_ip_address=192.168.1.1" \
  -F "location={\"latitude\": 37.7749, \"longitude\": -122.4194, \"altitude\": 0}" \
  http://example.com/upload
                    

Querying the status of an scanned image


curl http://example.com/status/your_image_id
                    

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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 OR COPYRIGHT HOLDERS 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.

Contact

Feel free to get in touch with questions, suggestions, or requests for customizations or support.

Note: Modtools Image is pre-release software

Please note that Modtools Image is currently in the early stages of development. Some features and documentation are missing or incomplete. This pre-release is being provided for the purpose of inspiring a community of developers to join us to realize the vision of an open source image moderation tool that integrates popular APIs for screening out adult content and CSAM.

Jeremy Malcolm
Trust & Safety Consultant

Get Connected