Submitting a Pugin

One of the great things about Enki is, that it can be extended with plugins and these plugins can be shared with other users.

If you have taken the time to create a package for Enki, please share it with other users.

To submit a new plugin to the repository:

1. Pick a module name

An Enki plugin is a Python package. Thus the part about the naming of packages of the Python style guide (PEP 8) applies:

Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability.

Python packages should also have short, all-lowercase names, although the use of underscores is discouraged.

1. Host a public GitHub repository

• Create a GitHub repository with the chosen module name. Only include on plugin per repository.
• Right now GitHub repositories are the only way to host an Enki plugin.
• Upload your files

2. Clean up repository

• remove all unnecessary files: especially any .pyc files and binary files
• check file names for invalid characters, try to use only underscore letters, numbers and underscores

3. Create a release

If your plugin is ready for deployment create a release with a semantic version number tag. Your first release should be 0.1.0.

4. Add repo to base repo

1. fork the enki-plugin-repository
2. add your entry of your plugin to the plugins section in repository.json

		{
			"name": "Test Plugin",
			"description": "Test the plugin for enki pluginmanager install functionality",
			"details": "https://github.com/<your_github_username>/<your_enki_plugin_name>",
			"download": "https://github.com/<your_github_username>/<your_enki_plugin_name>/archive/0.1.1.zip",
			"author": "Test Programmer",
			"version": "0.1.1",
			"labels": ["label1", "label2"]
		}

Important: Add the url of the release zip as the download url.

5. Submit a pull request

Commit your changes to your fork and submit a pull request to enki-plugin-repository