diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0e88606 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +*.pyc* +dist/ +build/ +*.egg-info/ + +.venv* diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..088f752 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,4 @@ +recursive-include alchemy * +include LICENSE +include README.md +include screenshot.jpg diff --git a/README.md b/README.md index 491bb61..2bbded4 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ Inspired by [crowsfoot](http://github.com/porterjamesj/crowsfoot) and [clean-blo ## Installation +### From Git repo + Clone the repo: ```bash @@ -47,6 +49,21 @@ And in Pelican config: THEME = 'themes/pelican-alchemy/alchemy' ``` +### With pip + +Alternatively, you can install this theme with pip: + +```bash +pip install "https://github.com/nairobilug/pelican-alchemy/tarball/master" +``` + +And import it from Pelican config: + +```python +import alchemy +THEME = alchemy.path() +``` + ## Usage Visit the [Settings wiki](https://github.com/nairobilug/pelican-alchemy/wiki/Settings) for examples: diff --git a/alchemy/__init__.py b/alchemy/__init__.py new file mode 100644 index 0000000..8fe84ea --- /dev/null +++ b/alchemy/__init__.py @@ -0,0 +1,14 @@ +''' +A functional, clean, responsive Pelican theme +''' + + +from pkg_resources import resource_filename + + +def path(): + ''' + Return path to theme templates and assets + Use this as value for THEME in Pelican settings + ''' + return resource_filename(__name__, '') diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..b0803ee --- /dev/null +++ b/setup.py @@ -0,0 +1,19 @@ +from setuptools import setup + + +setup( + name='alchemy', + version='2.2', + description='A functional, clean, responsive Pelican theme', + url='https://github.com/nairobilug/pelican-alchemy', + author='Nairobi GNU/Linux Users Group', + license='MIT', + platforms='any', + entry_points={}, + packages=['alchemy'], + include_package_data=True, + install_requires=[ + 'pelican', + ], + zip_safe=False, +)