Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add setup.py with main entry point #49

Merged
merged 1 commit into from
Sep 11, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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='[email protected]',
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'
]
)