Pinax Command Line Interface
Table of Contents
- About Pinax
- Change Log
- Code of Conduct
- Connect with 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 is a command-line interface for installing Pinax starter projects
and learning more about the latest Pinax app releases.
Supported Django and Python versions
|Django \ Python||2.7||3.4||3.5||3.6|
To install pinax-cli:
$ pip install pinax-cli
Invoke pinax-cli with
$ pinax <cmd> using one of the following commands:
Show a list of Pinax apps with their release version in the latest Pinax distribution.
$ pinax apps
Show a list of Pinax demonstration projects with their release version in the latest Pinax distribution.
$ pinax demos
Show a list of Pinax starter projects and their release version in the latest Pinax distribution.
$ 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
Show a list of Pinax tools with their release version in the latest Pinax distribution.
$ pinax tools
pinax start <starter_project> <my_project> [--dev] [--location <path>]
Create a new project based on a specific Pinax starter project.
<starter_project> must be one of the project names shown by
--dev flag tells pinax-cli to install the latest starter project code from the repository rather than the most recent release.
Use this option if you require the latest version of a starter project.
--location <path> flag tells pinax-cli where to create the new project. By default
the project is created in a sub-directory named
- Restore support for Django 1.11 with Python 2.7
- Drop support for Python 2.7 and Django < 2.0; require Python 3.4+ and Django 2.0+
- Use Django v1.11 for project creation if installed Python == 2.7
- Add usage examples, color, and sub-command short description to help
djangorequirements to setup.py
- Fix post-start cleanup path references
- Drop Python 3.3 support
- Standardize documentation layout
- Move documentation into README.md
- Convert CI and coverage to CircleCi and CodeCov
- Add PyPi-compatible long description
- Improve .gitignore
- Add "apps", "demos", "themes", and "tools" commands.
For an overview on how contributing to Pinax works read this blog post and watch the included video, or read our How to Contribute section. For concrete contribution ideas, please see our Ways to Contribute/What We Need Help With section.
In case of any questions we recommend you join our Pinax Slack team 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.
Code of Conduct
In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a 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
Copyright (c) 2012-2018 James Tauber and contributors under the MIT license.