Skip to content

Commit 2354238

Browse files
- updates docs, adds travis-ci build + python package manifest.
1 parent 8f7c539 commit 2354238

7 files changed

+50
-21
lines changed

.gitignore

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,34 @@
1+
# python compiled code
12
*.py[co]
23

3-
# Packages
4+
# packages
45
*.egg
56
*.egg-info
67
dist
78
build
89
eggs
910
parts
10-
bin
11+
# bin
1112
var
1213
sdist
1314
develop-eggs
1415
.installed.cfg
16+
*.swp
1517

16-
# Installer logs
18+
# installer logs
1719
pip-log.txt
1820

19-
# Unit test / coverage reports
21+
# unit test / coverage reports
2022
.coverage
2123
.tox
2224

23-
#Translations
25+
# translations
2426
*.mo
2527

26-
#Mr Developer
28+
# mr developer
2729
.mr.developer.cfg
2830

31+
# sphinx docs
2932
docs/_build
3033
docs/build
3134
.DS_Store
@@ -35,3 +38,6 @@ objects.inv
3538
/*.html
3639
/_static/
3740
/_sources/
41+
42+
# osx files
43+
.DS_Store

.travis.yml

+5-4
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ python:
44
- 2.7
55

66
install:
7-
- wget https://googleappengine.googlecode.com/files/google_appengine_1.8.1.zip -nv
8-
- unzip -q google_appengine_1.8.1.zip
7+
- wget https://googleappengine.googlecode.com/files/google_appengine_1.8.9.zip -nv
8+
- unzip -q google_appengine_1.8.9.zip
99
- export PYTHONPATH=$PYTHONPATH:$PWD/google_appengine
10-
- pip install -r requirements.txt
10+
- python setup.py install
1111

12-
script: python setup.py test
12+
script:
13+
- python setup.py check clean sdist nosetests
1314

1415
branches:
1516
only:

CHANGES CHANGES.md

File renamed without changes.

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2013 by gregorynicholas.
1+
Copyright (c) 2015 by gregorynicholas.
22

33
Some rights reserved.
44

MANIFEST.in

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
include README.md
2+
include CHANGES.md
3+
include LICENSE
4+
include requirements.txt

README.md

+26-10
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,56 @@
11
flask-telegram
22
==============
33

4-
54
[flask](http://flask.pocoo.org) extension for delivering messages.
6-
send via google [app engine's](http://appengine.google.com) mail or xmpp
7-
apis, and/or other third party providers such as
8-
[sendgrid](http://sendgrid.com).
95

10-
[![Build Status](https://secure.travis-ci.org/gregorynicholas/flask-telegram.png?branch=master)](https://travis-ci.org/gregorynicholas/flask-telegram)
6+
send using [google app-engine](http://appengine.google.com) `mail` or `xmpp` apis,
7+
and/or other third party providers such as [sendgrid](http://sendgrid.com)
8+
9+
10+
<br>
11+
**build-status:**
12+
13+
`master ` [![travis-ci build-status: master](https://secure.travis-ci.org/gregorynicholas/flask-telegram.svg?branch=master)](https://travis-ci.org/gregorynicholas/flask-telegram)
14+
<br>
15+
`develop` [![travis-ci build-status: develop](https://secure.travis-ci.org/gregorynicholas/flask-telegram.svg?branch=develop)](https://travis-ci.org/gregorynicholas/flask-telegram)
1116

1217

13-
* [docs](http://gregorynicholas.github.io/flask-telegram)
18+
**links:**
19+
20+
* [homepage](http://gregorynicholas.github.io/flask-telegram)
1421
* [source](http://github.com/gregorynicholas/flask-telegram)
15-
* [package](http://packages.python.org/flask-telegram)
16-
* [changelog](https://github.com/gregorynicholas/flask-telegram/blob/master/CHANGES)
22+
* [python-package](http://packages.python.org/flask-telegram)
23+
* [github-issues](https://github.com/gregorynicholas/flask-telegram/issues)
24+
* [changelog](https://github.com/gregorynicholas/flask-telegram/blob/master/CHANGES.md)
1725
* [travis-ci](http://travis-ci.org/gregorynicholas/flask-telegram)
1826

1927

28+
<br>
2029
-----
30+
<br>
2131

2232

2333
### getting started
2434

25-
install with *pip*:
2635

27-
pip install flask-telegram
36+
install with pip:
37+
38+
$ pip install flask-telegram
2839

2940

41+
<br>
3042
-----
43+
<br>
3144

3245

3346
### features
3447

3548
* [todo]
3649

3750

51+
<br>
3852
-----
53+
<br>
3954

4055

4156
### example usage
@@ -74,6 +89,7 @@ setup from outside the flask app request context:
7489
message.deliver(recipient=recipient, **context)
7590

7691

92+
7793
setup from within the flask app request context:
7894

7995
[todo]

setup.cfg

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
; [wheel]
2+
; universal = 1

0 commit comments

Comments
 (0)