Skip to content

Commit dcbc382

Browse files
committed
Add django>=1.11 to requirements
Update CI config Remove doc build support Add sorting guidance for 3rd-party app imports Improve documentation markup
1 parent 5f5c2b7 commit dcbc382

File tree

8 files changed

+36
-34
lines changed

8 files changed

+36
-34
lines changed

.circleci/config.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ common: &common
77
- restore_cache:
88
keys:
99
- v2-deps-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.py" }}-{{ checksum "tox.ini" }}
10-
- v2-deps-
1110
- run:
1211
name: install dependencies
1312
command: pip install --user tox
@@ -35,7 +34,7 @@ jobs:
3534
lint:
3635
<<: *common
3736
docker:
38-
- image: circleci/python:3.6.1
37+
- image: circleci/python:3.6
3938
environment:
4039
- TOXENV=checkqa
4140
- UPLOAD_COVERAGE=0

AUTHORS

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
Patrick Altman
2-
Brian Rosner
2+
Brian Rosner
33
Katherine “Kati” Michel
4+
Graham Ullrich

Makefile

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
1-
all: init docs test
1+
all: init test
22

33
init:
44
python setup.py develop
5-
pip install detox coverage mkdocs
5+
pip install detox coverage
66

77
test:
88
coverage erase
99
detox
1010
coverage html
11-
12-
docs:
13-
mkdocs build
14-
15-
.PHONY: docs

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,23 +54,26 @@ Django \ Python | 2.7 | 3.4 | 3.5 | 3.6
5454

5555
To install pinax-events:
5656

57-
pip install pinax-events
57+
```commandline
58+
$ pip install pinax-events
59+
```
5860

5961
Add `pinax-events` to your `INSTALLED_APPS` setting:
6062

6163
```python
62-
INSTALLED_APPS = (
63-
...
64+
INSTALLED_APPS = [
65+
# other apps
6466
"imagekit",
6567
"pinax.events",
66-
...
67-
)
68+
]
6869
```
6970

7071
You will need either `PIL` or `Pillow` installed for `imagekit` to work. We
7172
recommend `Pillow`:
7273

73-
pip install Pillow
74+
```commandline
75+
$ pip install Pillow
76+
```
7477

7578
### Settings
7679

@@ -93,15 +96,19 @@ In your template where you want to display events:
9396

9497
First, load the template tags:
9598

99+
```djangotemplate
96100
{% load pinax_events_tags %}
101+
```
97102

98103
Then:
99104

105+
```djangotemplate
100106
{% events as event_items %}
107+
```
101108

102109
And here is an example that how you can show the events:
103110

104-
```html
111+
```djangotemplate
105112
<section class="event-list">
106113
{% for event in event_items %}
107114
<article class="event" style="{% if event.secondary_image_thumb %}background-image:url({% static event.secondary_image_thumb.url %});{% endif %}">
@@ -136,6 +143,14 @@ Add and manage events via the Django admin.
136143

137144
## Change Log
138145

146+
### 2.0.3
147+
148+
* Add django>=1.11 to requirements
149+
* Update CI config
150+
* Remove doc build support
151+
* Add sorting guidance for 3rd-party app imports
152+
* Improve documentation markup
153+
139154
### 2.0.2
140155

141156
* fix setup.py LONG_DESCRIPTION for PyPi

mkdocs.yml

Lines changed: 0 additions & 9 deletions
This file was deleted.

runtests.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
"pinax.events",
1616
"pinax.events.tests"
1717
],
18-
MIDDLEWARE_CLASSES=[],
1918
DATABASES={
2019
"default": {
2120
"ENGINE": "django.db.backends.sqlite3",

setup.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
from setuptools import find_packages, setup
22

3+
VERSION = "2.0.3"
34
LONG_DESCRIPTION = """
45
.. image:: http://pinaxproject.com/pinax-design/patches/pinax-events.svg
56
:target: https://pypi.python.org/pypi/pinax-events/
@@ -54,7 +55,7 @@
5455
description="a simple app for publishing events on your site",
5556
name="pinax-events",
5657
long_description=LONG_DESCRIPTION,
57-
version="2.0.2",
58+
version=VERSION,
5859
url="http://github.com/pinax/pinax-events/",
5960
license="MIT",
6061
packages=find_packages(),
@@ -66,8 +67,9 @@
6667
"Pillow"
6768
],
6869
install_requires=[
70+
"django>=1.11",
6971
"django-imagekit>=3.3",
70-
"Markdown>=2.6.6"
72+
"Markdown>=2.6.6",
7173
],
7274
classifiers=[
7375
"Development Status :: 5 - Production/Stable",

tox.ini

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22
ignore = E265,E501
33
max-line-length = 100
44
max-complexity = 10
5-
exclude = pinax/events/migrations/*
5+
exclude = **/*/migrations/*
66
inline-quotes = double
77

88
[isort]
99
multi_line_output=3
1010
known_django=django
11-
known_third_party=pinax
11+
known_third_party=imagekit,markdown,pinax
1212
sections=FUTURE,STDLIB,DJANGO,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
13-
skip_glob=*/pinax/events/migrations/*
13+
skip_glob=**/*/migrations/*
1414

1515
[coverage:run]
1616
source = pinax
17-
omit = pinax/events/conf.py,pinax/events/tests/*,pinax/events/migrations/*
17+
omit = **/*/conf.py,**/*/tests/*,**/*/migrations/*
1818
branch = true
1919
data_file = .coverage
2020

2121
[coverage:report]
22-
omit = pinax/events/conf.py,pinax/events/tests/*,pinax/events/migrations/*
22+
omit = **/*/conf.py,**/*/tests/*,**/*/migrations/*
2323
exclude_lines =
2424
coverage: omit
2525
show_missing = True

0 commit comments

Comments
 (0)