Update documentation to current convention

Remove Travis CI, switch to CircleCi. Improve .gitignore. Update requirements to ">=" latest releases.
pinax · Jan 15, 2018 · 7bb886b · 7bb886b
1 parent 55dcd9f
commit 7bb886b
Show file tree

Hide file tree

Showing 11 changed files with 283 additions and 129 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,14 @@
+version: 2.0
+
+jobs:
+  lint:
+    docker:
+      - image: circleci/python:3.6
+        environment:
+          - TOXENV=checkqa
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - lint
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,45 @@
-build
-dist
-.coverage
-.tox
 MANIFEST
-*.pyc
-*.egg-info
-*.egg
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
 docs/_build/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+*.eggs
+.python-version
+
+# Pipfile
+Pipfile
+Pipfile.lock
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
 htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# IDEs
+.idea/
diff --git a/.travis.yml b/.travis.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -86,14 +86,13 @@ Here is an example of these rules applied:
     # non-from imports go first then from style import in their own group
     import csv
 
-    # second set of imports are Django imports with contrib in their own
-    # group.
-    from django.core.urlresolvers import reverse
+    # second set of imports are Django imports
+    from django.contrib.auth.models import User
     from django.db import models
+    from django.urls import reverse
     from django.utils import timezone
     from django.utils.translation import ugettext_lazy as _
 
-    from django.contrib.auth.models import User
 
     # third set of imports are external apps (if applicable)
     from tagging.fields import TagField

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,3 @@
 include AUTHORS
 include LICENSE
-include README.rst
+include README.md
diff --git a/Makefile b/Makefile
@@ -1,10 +1,5 @@
-all: init docs
+all: init
 
 init:
 	python setup.py develop
-	pip install detox coverage mkdocs
-
-docs:
-	mkdocs build
-
-.PHONY: docs
+	pip install detox coverage
diff --git a/README.md b/README.md
@@ -0,0 +1,148 @@
+![](http://pinaxproject.com/pinax-design/patches/pinax-cli.svg)
+
+# Pinax Command Line Interface
+
+[![](https://img.shields.io/pypi/v/pinax-cli.svg)](https://pypi.python.org/pypi/pinax-cli/)
+
+[![CircleCi](https://img.shields.io/circleci/project/github/pinax/pinax-cli.svg)](https://circleci.com/gh/pinax/pinax-cli)
+[![Codecov](https://img.shields.io/codecov/c/github/pinax/pinax-cli.svg)](https://codecov.io/gh/pinax/pinax-cli)
+[![](https://img.shields.io/github/contributors/pinax/pinax-cli.svg)](https://github.com/pinax/pinax-cli/graphs/contributors)
+[![](https://img.shields.io/github/issues-pr/pinax/pinax-cli.svg)](https://github.com/pinax/pinax-cli/pulls)
+[![](https://img.shields.io/github/issues-pr-closed/pinax/pinax-cli.svg)](https://github.com/pinax/pinax-cli/pulls?q=is%3Apr+is%3Aclosed)
+
+[![](http://slack.pinaxproject.com/badge.svg)](http://slack.pinaxproject.com/)
+[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+## Table of Contents
+
+* [About Pinax](#about-pinax)
+* [Overview](#overview)
+  * [Features](#features)
+  * [Supported Django and Python versions](#supported-django-and-python-versions)
+* [Documentation](#documentation)
+  * [Installation](#installation)
+  * [Usage](#usage)
+* [Change Log](#change-log)
+* [History](#history)
+* [Contribute](#contribute)
+* [Code of Conduct](#code-of-conduct)
+* [Connect with Pinax](#connect-with-pinax)
+* [License](#license)
+
+
+## About Pinax
+
+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. This collection can be found at http://pinaxproject.com.
+
+
+## pinax-cli
+
+### Overview
+
+`pinax-cli` is a command-line interface for installing Pinax starter projects
+and learning more about the latest Pinax app releases.
+
+
+## Documentation
+
+### Installation
+
+To install pinax-cli:
+
+    pip install pinax-cli
+
+
+### Usage
+
+Invoke pinax-cli with `$ pinax <cmd>` using one of the following commands:
+
+#### `pinax apps`
+
+Show a list of Pinax apps with their release version in the latest Pinax distribution.
+
+```commandline
+$ pinax apps
+```
+
+#### `pinax demos`
+
+Show a list of Pinax demonstration projects with their release version in the latest Pinax distribution.
+
+```commandline
+$ pinax demos
+```
+
+#### `pinax projects`
+
+Show a list of Pinax starter projects and their release version in the latest Pinax distribution.
+
+```commandline
+$ pinax projects
+Release Project
+------- ---------------
+  4.0.0 account
+  4.0.0 blog
+  2.0.0 company
+        documents
+        social-auth
+  4.0.0 static
+  4.0.0 stripe
+        team-wiki
+  3.0.0 waitinglist
+        wiki
+  4.0.0 zero
+```
+
+#### `pinax tools`
+
+Show a list of Pinax tools with their release version in the latest Pinax distribution.
+
+```commandline
+$ pinax tools
+```
+
+
+## Change Log
+
+### 1.1.0
+
+* Drop Python 3.3 support
+* Add "apps", "demos", and "tools" commands.
+* Standardize documentation layout
+* Move documentation into README.md
+* Convert CI and coverage to CircleCi and CodeCov
+* Add PyPi-compatible long description
+* Improve .gitignore
+
+
+## Contribute
+
+For an overview on how contributing to Pinax works read this [blog post](http://blog.pinaxproject.com/2016/02/26/recap-february-pinax-hangout/)
+and watch the included video, or read our [How to Contribute](http://pinaxproject.com/pinax/how_to_contribute/) section.
+For concrete contribution ideas, please see our
+[Ways to Contribute/What We Need Help With](http://pinaxproject.com/pinax/ways_to_contribute/) section.
+
+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.
+
+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/).
+
+
+## Code of Conduct
+
+In order to foster a kind, inclusive, and harassment-free community, the Pinax Project
+has a [code of conduct](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.
+
+
+## Connect with Pinax
+
+For updates and news regarding the Pinax Project, please follow us on Twitter [@pinaxproject](https://twitter.com/pinaxproject)
+and check out our [Pinax Project blog](http://blog.pinaxproject.com).
+
+
+## License
+
+Copyright (c) 2012-2018 James Tauber and contributors under the [MIT license](https://opensource.org/licenses/MIT).
diff --git a/README.rst b/README.rst
diff --git a/pcli.py b/pcli.py
@@ -2,10 +2,9 @@
 import stat
 import sys
 
-from pip.commands import install
-
 import click
 import requests
+from pip.commands import install
 
 
 class Config(object):
@@ -115,12 +114,6 @@ def demos(config):
     show_distribution_section(config, "Demo", "demos")
 
 
-@main.command()
-@pass_config
-def themes(config):
-    show_distribution_section(config, "Theme", "themes")
-
-
 @main.command()
 @pass_config
 def tools(config):