Skip to content

Commit

Permalink
Merge pull request #49 from Jyrsa/setup.py
Browse files Browse the repository at this point in the history
add setup.py with main entry point
  • Loading branch information
bast committed Sep 11, 2017
2 parents 9fe2764 + f03f3d3 commit a915cba
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 11 deletions.
33 changes: 22 additions & 11 deletions doc/local.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,34 @@


Running the app on your computer
================================
Running the app locally
=======================

Sometimes you need to present your talk without an internet connection.
In this situation you can run a local web server.
In this situation you can run a local web server::

$ virtualenv venv
$ source venv/bin/activate
(venv)$ pip install git+https://github.com/bast/cicero.git@master#egg=cicero
(venv)$ cicero
* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)

How to preview and serve your talk locally
==========================================

Using a local server it is also no problem to serve your talk locally to see the
result before you push them to the repository::

$ cicero --file /home/user/my-talk/talk.md

Development
===========
First install the dependencies (you need a network connection for this step)::

$ virtualenv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ git checkout https://github.com/bast/cicero
$ cd cicero

Then start the server::

Expand All @@ -19,10 +37,3 @@ Then start the server::
* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)


How to preview and serve your talk locally
==========================================

Using a local server it is also no problem to serve your talk locally to see the
result before you push them to the repository::

$ python cicero.py --file /home/user/my-talk/talk.md
24 changes: 24 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#!/usr/bin/env python

from distutils.core import setup

setup(name='cicero',
version='0.1.0',
description='Cicero - Serving slides written in Markdown.',
author='Radovan Bast',
author_email='bast@users.noreply.github.com',
url='https://github.com/bast/cicero',
packages=['cicero'],
license='GNU Lesser General Public License 2.1',
entry_points={
'console_scripts': [
'cicero = cicero.main:main'
]
},
install_requires=[
'requests',
'sphinx',
'sphinx_rtd_theme',
'flask>=0.10.1,<0.10.2'
]
)

0 comments on commit a915cba

Please sign in to comment.