cookiecutter-pelican-plugin

KO | EN

gitlite — search

#javascript #react #llm #golang #go #android #linux #java #windows #cli #awesome-list #security #mcp #openai

cookiecutter-pelican-plugin

(★ 16)

CookieCutter template for creating Pelican plugins

cookiecutter-pelican-plugin 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Pelican Plugin CookieCutter Template

This project’s purpose is to make it easy to create new Pelican plugins via a [CookieCutter][] template, as well as keeping generated plugins updated and in sync with template changes via [Cruft][].

## Requirements

**Option 1**: Install [Cruft][] via its [installation instructions](https://cruft.github.io/cruft/#installation).

**Option 2**: Install [Pipx][] and prefix the `cruft` commands below with: `pipx run [...]`

The latter option downloads and runs Cruft in a temporary environment. This is useful if you want to occasionally run Cruft but don’t need it frequently enough to install it on your computer.

## Generate New Plugin from Template

To create a new Pelican plugin in the current working directory, enter the following command in your terminal console:

cruft create https://github.com/getpelican/cookiecutter-pelican-plugin

You will then be asked to fill in details about the new plugin. Many of the default values, shown in brackets, can be accepted by tapping the `Return` key, while other inputs such as the plugin name and authors must be explicitly entered via the respective interactive prompts. Alternatively, some values can be provided to the `cruft` invocation in JSON format, such as:

cruft create https://github.com/getpelican/cookiecutter-pelican-plugin --extra-context '{"plugin_name": "Render Math"}'

### Continuous Deployment

The generated plugin contains a `.github/workflows/main.yml` file for continuous integration (CI) and deployment via [GitHub Actions][] and [AutoPub][] that will ensure tests pass, check code style compliance, and publish packaged distributions to PyPI when a `RELEASE.md` file is present. For the latter step to function properly, please first ask a Pelican maintainer to make the necessary “Trusted Publisher” changes in PyPI settings.

## Add Cruft to Existing Project

1. Ensure plugin template is up-to-date (linter versions, etc.). Commit and push any changes to the template repo.
1. Run `cruft create https://github.com/getpelican/cookiecutter-pelican-plugin` to create a new project with the same name as the existing project.
1. Enter the requested information when prompted, copy+pasting relevant info from the existing project.
1. Diff-compare generated template to existing project, updating as needed to bring them into alignment.
1. Commit those manual changes to the existing project.
1. Copy generated `.cruft.json` file to the existing project, editing as necessary to ensure it is correct.
1. Commit and push `.cruft.json` file.

## Updating Existing Project via Cruft

Preparation:

cd ~/Projects/pelican-plugins/[PLUGIN-NAME]
    git pull origin main
    pdm update
    inv tests
    inv lint

Check:

cruft check   # or: invoke update --check

Update:

cruft update  # or: invoke update

See if anything broke:

pdm update
    inv tests
    inv lint

Add `.cruft.json` hash change and commit:

git add .cruft.json
    git commit -m "chore: Apply upstream template changes via Cruft"
    git push

[CookieCutter]: https://github.com/cookiecutter/cookiecutter
[Cruft]: https://github.com/cruft/cruft
[Pipx]: https://github.com/pipxproject/pipx
[GitHub Actions]: https://github.com/features/actions
[AutoPub]: https://justinmayer.com/projects/autopub/

cookiecutter-pelican-plugin

cookiecutter-pelican-plugin 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

cookiecutter-pelican-plugin

cookiecutter-pelican-plugin 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README