Cookiecutter Pelican Plugin

Overview

The Pelican Plugin CookieCutter Template streamlines the process of creating new Pelican plugins, making it accessible even for those without extensive experience in plugin development. By leveraging the capabilities of Cruft, this template not only simplifies the initial setup but also ensures that your plugins remain up to date with the latest template advancements and best practices.

With this tool, developers can easily generate and maintain plugins, significantly reducing the complexity ordinarily associated with such projects. Whether you're starting fresh or updating an existing plugin, this template is designed to provide a user-friendly experience and enhance productivity.

Features

• Easy Plugin Creation: Quickly generate new Pelican plugins using a simple command in the terminal, filling in straightforward prompts for essential details.
• Interactive Commands: User-friendly interactive prompts allow for seamless input of plugin-specific data, making the setup process straightforward.
• Continuous Deployment Integration: The generated plugin includes a GitHub Actions workflow for automated testing, code style checks, and publishing to PyPI, ensuring high-quality deployments.
• Up-to-Date Templates: Maintain alignment with the latest template updates by using Cruft to check and update existing projects quickly and efficiently.
• Streamlined Project Management: Facilitates easy additions to existing projects by updating the plugin template and copying necessary configurations.
• Improved Version Control: The integration of a .cruft.json file helps track changes and keep projects organized, allowing for easier updates and collaboration.
• Optional Temporary Environment: Use Pipx to run Cruft in a temporary environment if frequent installations are not required, enhancing flexibility in usage.