Skip to content

Commit

Permalink
Update setup.py and convert README to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
zeroSteiner committed May 24, 2018
1 parent f7e0b7d commit d3d37e8
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 31 deletions.
27 changes: 0 additions & 27 deletions README

This file was deleted.

29 changes: 29 additions & 0 deletions README.md
@@ -0,0 +1,29 @@
# PluginBase

PluginBase is a module for Python that enables the
development of flexible plugin systems in Python.

Step 1:
```python
from pluginbase import PluginBase
plugin_base = PluginBase(package='yourapplication.plugins')
```

Step 2:
```python
plugin_source = plugin_base.make_plugin_source(
searchpath=['./path/to/plugins', './path/to/more/plugins'])
```

Step 3:
```python
with plugin_source:
from yourapplication.plugins import my_plugin
my_plugin.do_something_cool()
```

Or alternatively:
```python
my_plugin = plugin_source.load_plugin('my_plugin')
my_plugin.do_something_cool()
```
20 changes: 16 additions & 4 deletions setup.py
@@ -1,8 +1,17 @@
try:
from setuptools import setup
except ImportError:
from distutils.core import setup
import os
import sys

base_directory = os.path.dirname(__file__)

from setuptools import setup

DESCRIPTION = """
PluginBase is a module for Python that enables the development of flexible \
plugin systems in Python.\
"""

with(os.path.join(base_directory, 'README.md'), 'r') as file_h:
long_description = file_h.read()

setup(
name='pluginbase',
Expand All @@ -11,6 +20,9 @@
maintainer='Spencer McIntyre',
maintainer_email='zeroSteiner@gmail.com',
version='0.7-dev',
description=DESCRIPTION,
long_description=long_description,
long_description_content_type='text/markdown',
url='http://github.com/mitsuhiko/pluginbase',
py_modules=['pluginbase'],
description='A support library for building plugins sytems in Python.',
Expand Down

0 comments on commit d3d37e8

Please sign in to comment.