Cookiecutter Toolforge

Overview

The cookiecutter-template for Wikimedia Toolforge is a streamlined solution for creating and managing tool projects using the Flask Python framework. This template not only simplifies the initial setup process but also ensures that developers can maintain high standards in coding and functionality. It's a valuable resource for both novice programmers looking to dive into Flask and seasoned developers aiming to establish new tools within the Wikimedia ecosphere.

With the ability to generate projects tailored to specific needs through straightforward prompts, this template facilitates quick deployment and efficient coding practices. From setting up essential libraries to integrating testing frameworks, it provides a comprehensive foundation ideal for developers working on collaborative projects.

Features

• Simple Installation: Get started easily by installing cookiecutter on your system and running a single command to create a new tool project.

• Metadata Prompting: During setup, users are guided to input essential metadata such as tool identifier, name, user name, and target wiki domain.

• Flake8 Integration: Optional setup for Flake8 helps maintain consistent code style, catching common programming errors and promoting best practices.

• Mypy Support: Enables static type checking through mypy, which is especially beneficial for larger tools that require precise type annotations.

• Automated Testing with Pytest: By enabling pytest, developers can create and run tests to ensure their tools perform correctly following code changes.

• Bootstrap HTML Template: Comes packed with a basic HTML template using Bootstrap v4.0, allowing for responsive design straight out of the box.

• Flask Routing & Templating: Includes examples of Flask routing and templating, making it easy to understand and implement for web applications.

• OAuth Authentication: Facilitates secure authentication against Wikimedia sites, enhancing user access management for your tools.