Skip to content

pollypm/example-package

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Polly Example Package

This is a demonstration package showing the proper structure and metadata requirements for creating Polly-compatible packages.

Package Files

.install.polly.json (Required)

This is the core metadata file that Polly uses to understand how to install your package.

Required fields:

  • install: a list of commands to be executed sequentially when the package is installed.
  • uninstall: a list of commands to be executed sequentially when the package is uninstalled.

Note: On package upgrade, the uninstall commands and then the install commands will be executed!

.polly.json (Optional)

Additional metadata for package discovery and information display.

Install File Format

{
  "install": [
    "echo Run commands here when the package is installed!"
  ],
  "uninstall": [
    "echo Run commands here when the package is uninstalled!"
  ]
}

Usage

  1. Test the example:

    python3 main.py
  2. Use as template:

    • Copy this directory structure
    • Modify .install.polly.json with your commands
    • Update .polly.json with your package information
    • Replace main.py with your application code

Notes

  • Install/uninstall commands are executed in the package directory during installation
  • Commands run with the privleges you give them, use sudo to run as root
  • Use absolute paths in when possible
  • Test your package structure before publishing

Learn More

About

Example package for Polly.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages