Skip to content

Commit

Permalink
Add documentation for external starter projects.
Browse files Browse the repository at this point in the history
  • Loading branch information
nrb committed Nov 11, 2011
1 parent ba61290 commit 476d239
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
11 changes: 11 additions & 0 deletions docs/starterprojects.txt
Expand Up @@ -156,3 +156,14 @@ the Django templating language. It uses ``pinax.views.static_view`` mounted
at ``/``. For example if you access ``/test.html`` it will render
``templates/test.html``. Directory paths, i.e., ``/a/``, will render
``/templates/a/index.html``.

External Starter Projects
=========================

The Pinax ``setup_project`` command can also use starter projects built by third parties.
These can either be plain directory structures, or they may be a git/hg pip editable.

To install a starter project from an external source, simply pass the file path or git/hg
URL to the ``-b`` option::

pinax-admin setup_project -b git+git://github.com/user/project.git#egg=project my_new_project

This comment has been minimized.

Copy link
@nisaacson

nisaacson May 30, 2012

Can you give an example of a live project that can be installed in this manner?

I am trying to create a new project using the latest dev branch of pinax-project-account and cannot see how to do this from the https://github.com/pinax/pinax-project-account page

see http://stackoverflow.com/questions/10804923/how-can-i-install-external-pinax-projects for more

This comment has been minimized.

Copy link
@nrb

nrb Jun 1, 2012

Author Owner

Sorry, I can't; this pull request is actually deprecated in favor of a different implementation. I haven't been too involved in the project for a few months now, you may want to check on #pinax in IRC to see if they have made any progress.

4 changes: 2 additions & 2 deletions pinax/core/management/commands/setup_project.py
Expand Up @@ -37,12 +37,12 @@ class Command(BaseCommand):
optparse.make_option("-l", "--list-bases",
dest = "list_bases",
action = "store_true",
help = "lists the starter projects (bases) that are available"
help = "lists the bundled starter projects (bases) that are available"
),
optparse.make_option("-b", "--base",
dest = "base",
default = "zero",
help = "the starter project to use as a base (excluding _project, e.g., basic or social. see --list-projects)"
help = "the starter project to use as a base (excluding _project, e.g., basic or social. see --list-projects for included starter projects). Valid git/hg PIP editable strings and plain file paths are accepted, as well."
),
optparse.make_option("--no-reqs",
dest = "no_reqs",
Expand Down

0 comments on commit 476d239

Please sign in to comment.