Skip to content

Commit a915cba

Browse files
authored
Merge pull request #49 from Jyrsa/setup.py
add setup.py with main entry point
2 parents 9fe2764 + f03f3d3 commit a915cba

File tree

2 files changed

+46
-11
lines changed

2 files changed

+46
-11
lines changed

doc/local.rst

+22-11
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,34 @@
11

2-
3-
Running the app on your computer
4-
================================
2+
Running the app locally
3+
=======================
54

65
Sometimes you need to present your talk without an internet connection.
7-
In this situation you can run a local web server.
6+
In this situation you can run a local web server::
7+
8+
$ virtualenv venv
9+
$ source venv/bin/activate
10+
(venv)$ pip install git+https://github.com/bast/cicero.git@master#egg=cicero
11+
(venv)$ cicero
12+
13+
* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
14+
15+
How to preview and serve your talk locally
16+
==========================================
17+
18+
Using a local server it is also no problem to serve your talk locally to see the
19+
result before you push them to the repository::
20+
21+
$ cicero --file /home/user/my-talk/talk.md
822

23+
Development
24+
===========
925
First install the dependencies (you need a network connection for this step)::
1026

1127
$ virtualenv venv
1228
$ source venv/bin/activate
1329
$ pip install -r requirements.txt
30+
$ git checkout https://github.com/bast/cicero
31+
$ cd cicero
1432

1533
Then start the server::
1634

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

2139

22-
How to preview and serve your talk locally
23-
==========================================
24-
25-
Using a local server it is also no problem to serve your talk locally to see the
26-
result before you push them to the repository::
27-
28-
$ python cicero.py --file /home/user/my-talk/talk.md

setup.py

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
#!/usr/bin/env python
2+
3+
from distutils.core import setup
4+
5+
setup(name='cicero',
6+
version='0.1.0',
7+
description='Cicero - Serving slides written in Markdown.',
8+
author='Radovan Bast',
9+
author_email='[email protected]',
10+
url='https://github.com/bast/cicero',
11+
packages=['cicero'],
12+
license='GNU Lesser General Public License 2.1',
13+
entry_points={
14+
'console_scripts': [
15+
'cicero = cicero.main:main'
16+
]
17+
},
18+
install_requires=[
19+
'requests',
20+
'sphinx',
21+
'sphinx_rtd_theme',
22+
'flask>=0.10.1,<0.10.2'
23+
]
24+
)

0 commit comments

Comments
 (0)