Skip to main content

Applies a standard set of configuration files for Plone repositories

Project description

plone.meta

plone.meta standardizes configuration files across Plone-related Python repositories.

It generates and manages .editorconfig, .flake8, .gitignore, pyproject.toml, tox.ini, .pre-commit-config.yaml, and CI pipelines (GitHub Actions, GitLab CI) from Jinja2 templates, with per-repository customization via .meta.toml.

Quick Start

python3 -m venv venv
venv/bin/pip install plone.meta
venv/bin/config-package /path/to/your/package

Documentation

Full documentation is available at https://plone.github.io/meta/

  • Tutorials -- Step-by-step lessons to get started
  • How-To Guides -- Solutions to specific problems
  • Reference -- Configuration options and CLI details
  • Explanation -- Architecture, design decisions, and philosophy

Commands

  • config-package -- Generate configuration files for a single repository
  • multi-call -- Apply configuration across multiple repositories
  • re-enable-actions -- Re-enable auto-disabled GitHub Actions

GitHub Actions Shared Automations

plone.meta also provides reusable workflows and composite actions for GitHub Actions. See the full documentation for details.

Scope

plone/meta covers single-package Python repositories. It does not cover:

  • Volto or other JavaScript-based projects
  • Monorepo projects (backend + frontend)
  • Projects supporting multiple Plone versions in the same branch

License

GPLv2. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plone_meta-2.8.0.tar.gz (86.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plone_meta-2.8.0-py3-none-any.whl (52.9 kB view details)

Uploaded Python 3

File details

Details for the file plone_meta-2.8.0.tar.gz.

File metadata

  • Download URL: plone_meta-2.8.0.tar.gz
  • Upload date:
  • Size: 86.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for plone_meta-2.8.0.tar.gz
Algorithm Hash digest
SHA256 0fa7b44b64a55b3cd7f8598e1ef941995570e0895dd1271b7244e7e8c6921585
MD5 f47ad3d334198a2aaa61efca4ce49fc3
BLAKE2b-256 88ce489be46b653957b680ba7c9fe9a9dadc105cf795d4861da0e62c9a49ef27

See more details on using hashes here.

File details

Details for the file plone_meta-2.8.0-py3-none-any.whl.

File metadata

  • Download URL: plone_meta-2.8.0-py3-none-any.whl
  • Upload date:
  • Size: 52.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for plone_meta-2.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7fee2ffaf567c37023723a84ac1029f860951761f4b5a8c1759da563593c7265
MD5 936c21eea4b35378e4b443831bf99888
BLAKE2b-256 b549b1dbcc64db3ae4207a688a84349bc459449dff9685569987258cff1bcfd0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page