Skip to content

Commit 436de9d

Browse files
grahamugrahamu
committed
Update django>=1.11 in requirements
Remove pytest from CI Add PyPi-compatible docs in setup.py Revise trove classifiers Improve .gitignore Update CI configuration
1 parent 3be217d commit 436de9d

File tree

7 files changed

+242
-80
lines changed

7 files changed

+242
-80
lines changed

‎.circleci/config.yml

+1-2
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
@@ -34,7 +33,7 @@ jobs:
3433
lint:
3534
<<: *common
3635
docker:
37-
- image: circleci/python:3.6.1
36+
- image: circleci/python:3.6
3837
environment:
3938
TOXENV=checkqa
4039
py27dj18:

‎.gitignore

+42-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,45 @@
1-
build
2-
dist
3-
.coverage
4-
.tox
5-
.idea
61
MANIFEST
7-
*.pyc
8-
*.egg-info
9-
*.egg
2+
.DS_Store
3+
4+
# Byte-compiled / optimized / DLL files
5+
__pycache__/
6+
*.py[cod]
7+
8+
9+
# Distribution / packaging
10+
.Python
11+
env/
12+
build/
13+
develop-eggs/
14+
dist/
1015
docs/_build/
16+
eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
*.egg-info/
23+
.installed.cfg
24+
*.egg
25+
*.eggs
26+
.python-version
27+
28+
# Pipfile
29+
Pipfile
30+
Pipfile.lock
31+
32+
# Installer logs
33+
pip-log.txt
34+
pip-delete-this-directory.txt
35+
36+
# Unit test / coverage reports
1137
htmlcov/
38+
.tox/
39+
.coverage
40+
.cache
41+
nosetests.xml
42+
coverage.xml
43+
44+
# IDEs
45+
.idea/

‎README.md

+108-34
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,98 @@
33
# Pinax Templates
44

55
[![](https://img.shields.io/pypi/v/pinax-templates.svg)](https://pypi.python.org/pypi/pinax-templates/)
6-
[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://pypi.python.org/pypi/pinax-templates/)
76

7+
[![CircleCi](https://img.shields.io/circleci/project/github/pinax/pinax-templates.svg)](https://circleci.com/gh/pinax/pinax-templates)
88
[![Codecov](https://img.shields.io/codecov/c/github/pinax/pinax-templates.svg)](https://codecov.io/gh/pinax/pinax-templates)
9-
[![CircleCI](https://circleci.com/gh/pinax/pinax-templates.svg?style=svg)](https://circleci.com/gh/pinax/pinax-templates)
10-
![](https://img.shields.io/github/contributors/pinax/pinax-templates.svg)
11-
![](https://img.shields.io/github/issues-pr/pinax/pinax-templates.svg)
12-
![](https://img.shields.io/github/issues-pr-closed/pinax/pinax-templates.svg)
9+
[![](https://img.shields.io/github/contributors/pinax/pinax-templates.svg)](https://github.com/pinax/pinax-templates/graphs/contributors)
10+
[![](https://img.shields.io/github/issues-pr/pinax/pinax-templates.svg)](https://github.com/pinax/pinax-templates/pulls)
11+
[![](https://img.shields.io/github/issues-pr-closed/pinax/pinax-templates.svg)](https://github.com/pinax/pinax-templates/pulls?q=is%3Apr+is%3Aclosed)
1312

1413
[![](http://slack.pinaxproject.com/badge.svg)](http://slack.pinaxproject.com/)
14+
[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
1515

16+
## Table of Contents
17+
18+
* [About Pinax](#about-pinax)
19+
* [Overview](#overview)
20+
* [Features](#features)
21+
* [Supported Pinax Apps](supported-pinax-apps)
22+
* [Supported Django and Python versions](#supported-django-and-python-versions)
23+
* [Documentation](#documentation)
24+
* [Installation](#installation)
25+
* [Usage](#usage)
26+
* [Template Browser](#template-browser)
27+
* [FAQ](#faq)
28+
* [Change Log](#change-log)
29+
* [Contribute](#contribute)
30+
* [Code of Conduct](#code-of-conduct)
31+
* [Connect with Pinax](#connect-with-pinax)
32+
* [License](#license)
33+
34+
## About Pinax
35+
36+
Pinax is an open-source platform built on the Django Web Framework. It is an ecosystem of reusable
37+
Django apps, themes, and starter project templates. This collection can be found at http://pinaxproject.com.
38+
39+
## pinax-templates
40+
41+
### Overview
42+
43+
`pinax-templates` provides semantically-correct templates for Pinax apps.
44+
45+
#### Supported Pinax Apps
46+
47+
* [django-user-accounts](https://github.com/pinax/django-user-accounts)
48+
* [pinax-announcements](https://github.com/pinax/pinax-announcements)
49+
* [pinax-blog](https://github.com/pinax/pinax-blog)
50+
* [pinax-cohorts](https://github.com/pinax/pinax-cohorts)
51+
* [pinax-documents](https://github.com/pinax/pinax-documents)
52+
* [pinax-invitations](https://github.com/pinax/pinax-invitations)
53+
* [pinax-likes](https://github.com/pinax/pinax-likes)
54+
* [pinax-notifications](https://github.com/pinax/pinax-notifications)
55+
* [pinax-stripe](https://github.com/pinax/pinax-stripe)
56+
57+
#### Supported Django and Python versions
58+
59+
Django \ Python | 2.7 | 3.4 | 3.5 | 3.6
60+
--------------- | --- | --- | --- | ---
61+
1.11 | * | * | * | *
62+
2.0 | | * | * | *
63+
64+
65+
## Documentation
66+
67+
### Installation
68+
69+
To install pinax-templates:
70+
71+
```shell
72+
$ pip install pinax-templates
73+
```
74+
75+
Add `pinax.templates` to your `INSTALLED_APPS` setting:
76+
77+
```python
78+
INSTALLED_APPS = [
79+
# other apps
80+
"pinax.templates",
81+
]
82+
```
83+
84+
85+
### Usage
86+
87+
With pinax-templates installed, all default templates for supported apps are ready for use.
1688

1789
## Template Browser
1890

19-
These templates have been dressed up with Bootstrap 4 styling at http://templates.pinaxproject.com.
91+
This project provides a template browser at http://templates.pinaxproject.com.
92+
Browse there to see each Pinax application template collection, dressed up with Bootstrap 4 styling.
2093

2194
On this site, you can browse all the templates in various different states. In
2295
addition there is a source toggle where you can view the template, see what blocks
2396
are defined, and easily copy and paste into your project if you want to override
24-
or customize.
97+
or customize the template code.
2598

2699
## FAQs
27100

@@ -36,48 +109,49 @@ or customize.
36109
### How do I change the titles on my pages?
37110

38111

39-
---
40-
41-
Pinax
42-
------
112+
## Change Log
43113

44-
Pinax is an open-source platform built on the Django Web Framework. It is an ecosystem of reusable Django apps, themes, and starter project templates.
114+
### 1.0.1
45115

46-
This collection can be found at http://pinaxproject.com.
116+
* Update django>=1.11 in requirements
117+
* Remove pytest from CI
118+
* Add PyPi-compatible docs in setup.py
119+
* Revise trove classifiers
120+
* Improve .gitignore
121+
* Update CI configuration
47122

123+
### 1.0.0
48124

49-
Running the Tests
50-
-------------------
51-
52-
```
53-
$ pip install detox
54-
$ detox
55-
```
125+
* Initial release
56126

57127

58-
Documentation
59-
---------------
128+
## Contribute
60129

61-
The `pinax-templates` documentation is currently under construction. If you would like to help us write documentation, please join our Pinax Project Slack team and let us know! The Pinax documentation is available at http://pinaxproject.com/pinax/.
130+
For an overview on how contributing to Pinax works read this [blog post](http://blog.pinaxproject.com/2016/02/26/recap-february-pinax-hangout/)
131+
and watch the included video, or read our [How to Contribute](http://pinaxproject.com/pinax/how_to_contribute/) section.
132+
For concrete contribution ideas, please see our
133+
[Ways to Contribute/What We Need Help With](http://pinaxproject.com/pinax/ways_to_contribute/) section.
62134

135+
In case of any questions we recommend you join our [Pinax Slack team](http://slack.pinaxproject.com)
136+
and ping us there instead of creating an issue on GitHub. Creating issues on GitHub is of course
137+
also valid but we are usually able to help you faster if you ping us in Slack.
63138

64-
Contribute
65-
----------------
139+
We also highly recommend reading our blog post on [Open Source and Self-Care](http://blog.pinaxproject.com/2016/01/19/open-source-and-self-care/).
66140

67-
See this blog post http://blog.pinaxproject.com/2016/02/26/recap-february-pinax-hangout/ including a video, or our How to Contribute (http://pinaxproject.com/pinax/how_to_contribute/) section for an overview on how contributing to Pinax works. For concrete contribution ideas, please see our Ways to Contribute/What We Need Help With (http://pinaxproject.com/pinax/ways_to_contribute/) section.
68141

69-
In case of any questions we recommend you join our Pinax Slack team (http://slack.pinaxproject.com) and ping us there instead of creating an issue on GitHub. Creating issues on GitHub is of course also valid but we are usually able to help you faster if you ping us in Slack.
142+
## Code of Conduct
70143

71-
We also highly recommend reading our Open Source and Self-Care blog post (http://blog.pinaxproject.com/2016/01/19/open-source-and-self-care/).
144+
In order to foster a kind, inclusive, and harassment-free community, the Pinax Project
145+
has a [code of conduct](http://pinaxproject.com/pinax/code_of_conduct/).
146+
We ask you to treat everyone as a smart human programmer that shares an interest in Python, Django, and Pinax with you.
72147

73148

74-
Code of Conduct
75-
----------------
149+
## Connect with Pinax
76150

77-
In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a code of conduct, which can be found here http://pinaxproject.com/pinax/code_of_conduct/. We ask you to treat everyone as a smart human programmer that shares an interest in Python, Django, and Pinax with you.
151+
For updates and news regarding the Pinax Project, please follow us on Twitter [@pinaxproject](https://twitter.com/pinaxproject)
152+
and check out our [Pinax Project blog](http://blog.pinaxproject.com).
78153

79154

80-
Pinax Project Blog and Twitter
81-
--------------------------------
155+
## License
82156

83-
For updates and news regarding the Pinax Project, please follow us on Twitter at @pinaxproject and check out our blog http://blog.pinaxproject.com.
157+
Copyright (c) 2012-2018 James Tauber and contributors under the [MIT license](https://opensource.org/licenses/MIT).

‎pinax/templates/models.py

Whitespace-only changes.

‎setup.cfg

-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,3 @@ long_description = file: README.md
33

44
[bdist_wheel]
55
universal = 1
6-
7-
[tool:pytest]
8-
testpaths = pinax/templates/tests
9-
DJANGO_SETTINGS_MODULE = pinax.templates.tests.settings

‎setup.py

+82-17
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,103 @@
11
from setuptools import find_packages, setup
22

3+
VERSION = "1.0.1"
4+
LONG_DESCRIPTION = """
5+
.. image:: http://pinaxproject.com/pinax-design/patches/pinax-templates.svg
6+
:target: https://pypi.python.org/pypi/pinax-templates/
7+
8+
===================
9+
Pinax Notifications
10+
===================
11+
12+
.. image:: https://img.shields.io/pypi/v/pinax-templates.svg
13+
:target: https://pypi.python.org/pypi/pinax-templates/
14+
15+
\
16+
17+
.. image:: https://img.shields.io/circleci/project/github/pinax/pinax-templates.svg
18+
:target: https://circleci.com/gh/pinax/pinax-templates
19+
.. image:: https://img.shields.io/codecov/c/github/pinax/pinax-templates.svg
20+
:target: https://codecov.io/gh/pinax/pinax-templates
21+
.. image:: https://img.shields.io/github/contributors/pinax/pinax-templates.svg
22+
:target: https://github.com/pinax/pinax-templates/graphs/contributors
23+
.. image:: https://img.shields.io/github/issues-pr/pinax/pinax-templates.svg
24+
:target: https://github.com/pinax/pinax-templates/pulls
25+
.. image:: https://img.shields.io/github/issues-pr-closed/pinax/pinax-templates.svg
26+
:target: https://github.com/pinax/pinax-templates/pulls?q=is%3Apr+is%3Aclosed
27+
28+
\
29+
30+
.. image:: http://slack.pinaxproject.com/badge.svg
31+
:target: http://slack.pinaxproject.com/
32+
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
33+
:target: https://pypi.python.org/pypi/pinax-templates/
34+
35+
\
36+
37+
``pinax-templates`` provides semantically-correct templates for use with Pinax apps.
38+
39+
40+
Supported Pinax Apps
41+
--------------------
42+
43+
* django-user-accounts
44+
* pinax-announcements
45+
* pinax-blog
46+
* pinax-cohorts
47+
* pinax-documents
48+
* pinax-invitations
49+
* pinax-likes
50+
* pinax-notifications
51+
* pinax-strip
52+
53+
54+
Supported Django and Python Versions
55+
------------------------------------
56+
57+
+-----------------+-----+-----+-----+-----+
58+
| Django / Python | 2.7 | 3.4 | 3.5 | 3.6 |
59+
+=================+=====+=====+=====+=====+
60+
| 1.11 | * | * | * | * |
61+
+-----------------+-----+-----+-----+-----+
62+
| 2.0 | | * | * | * |
63+
+-----------------+-----+-----+-----+-----+
64+
"""
365

466
setup(
5-
author="Pinax Developers",
6-
author_email="",
67+
author="Pinax Team",
68+
author_email="[email protected]",
769
description="semantic templates for pinax apps",
870
name="pinax-templates",
9-
version="1.0.0",
71+
long_description=LONG_DESCRIPTION,
72+
version=VERSION,
1073
url="https://github.com/pinax/pinax-templates/",
1174
license="MIT",
12-
long_description_content_type="text/markdown",
1375
packages=find_packages(),
1476
include_package_data=True,
15-
test_suite="runtests.runtests",
16-
install_requires=[
17-
"Django>=1.8",
18-
"django-bootstrap-form>=3.0.0"
19-
],
20-
tests_require=[
21-
],
22-
extras_require={
23-
"pytest": ["pytest", "pytest-django"]
24-
},
2577
classifiers=[
26-
"Development Status :: 4 - Beta",
78+
"Development Status :: 5 - Production/Stable",
2779
"Environment :: Web Environment",
2880
"Framework :: Django",
81+
'Framework :: Django :: 1.11',
82+
'Framework :: Django :: 2.0',
2983
"Intended Audience :: Developers",
3084
"License :: OSI Approved :: MIT License",
3185
"Operating System :: OS Independent",
3286
"Programming Language :: Python",
33-
"Programming Language :: Python :: 2",
34-
"Programming Language :: Python :: 3",
87+
'Programming Language :: Python :: 2',
88+
'Programming Language :: Python :: 2.7',
89+
'Programming Language :: Python :: 3',
90+
'Programming Language :: Python :: 3.4',
91+
'Programming Language :: Python :: 3.5',
92+
'Programming Language :: Python :: 3.6',
3593
"Topic :: Software Development :: Libraries :: Python Modules",
3694
],
95+
install_requires=[
96+
"django>=1.11",
97+
"django-bootstrap-form>=3.0.0"
98+
],
99+
tests_require=[
100+
],
101+
test_suite="runtests.runtests",
37102
zip_safe=False
38103
)

0 commit comments

Comments
 (0)