Commit 0055e078 authored by Maxime Vidori's avatar Maxime Vidori
Browse files

Simplify dev environment installation

This patch include a setup.py file which allows the developer to
use pip to install the dev environment in an easiest way.

It also contains some documentation in a README file

Fix some small issues: missing list_dir.tplt and not needed imports in
pelicanconf.py
parent d171bbe9
# Gitoyen website
The gitoyen website is build on
[pelican](http://docs.getpelican.com/en/3.6.3/),
this repo contains the source code and content needed to generate the
static website.
## Getting started
Pelican is based on python in order to make the site works you will need
at least python and pip installed.
Once this has been done run the following commands into this repository
folder:
### Virtualenv
If you want to keep things isolated on your machine you will have to
install virtualenv, this step is not mandatory but is recommended.
On debian just type: `apt-get install python-virtualenv`
Create a virtualenv in the root of the repository: `virtualenv ./venv`
Source the virtualenv in order to isolate your current session:
`source venv/bin/activate`, you can disable it later by typing `deactivate`
in the same shell session.
### Install and run
- `pip install -e .` will install the dependencies needed
by pelican
- `gitoyen serve` will serve the website in development mode
(i.e: livereload, local port)
## Repository organisation
The website is build on multiple sources:
- `gitoyen.py` this is the command line helper file, it provides a list
of usefull command for development. This script is installed when running
`pip install -e .`. It is based on [Click](http://click.pocoo.org/5/)
- `pelicanconf.py` is a python file for the configuration of the pelican
engine. It contains for example the path of the different directories which
will be used to build the website.
- `filters.py` some jinja2 filters which will add features for generating
the website.
- `content/` contains the site content in Markdown files, it is separated
in two subdirs: `pages`, `blog` the first subdir contains the pages of the
site, the second contains a list of blog articles.
- `templates/` some jinja templates for administration, it is used by
`gitoyen.py` file.
- `theme/` jinja templates and static files for generating the website.
- `plugins/` pelican plugins, currently there is only one installed to
generate tables of content.
- `setup.py` contains instructions on how to install the gitoyen cli and
the dependencies for running the dev environment.
......@@ -2,8 +2,6 @@
# -*- coding: utf-8 -*- #
from __future__ import unicode_literals
import sys
sys.path.append('.')
import filters
AUTHOR = u'gitoyen'
......
from setuptools import setup
setup(
name='Gitoyen',
version='1.0',
py_modules=['gitoyen'],
install_requires=[
'Click',
'pelican',
'markdown',
'ghp-import',
'click',
'path.py',
'livereload',
'beautifulsoup4',
],
entry_points='''
[console_scripts]
gitoyen=gitoyen:cli
'''
)
<html>
<head>
<title>Directory listing for {{directory}}</title>
</head>
<body>
<h2>Directory listing for {{directory}}</h2>
<hr>
<ul>
{% for link in links %}
<li><a href="{{ link }}">{{ link }}</a></li>
{% endfor %}
</ul>
<hr>
</body>
</html>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment