Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fix paths and synchronize instructions of git and non-git repos #10

Closed
wants to merge 8 commits into from

2 participants

Giorgos Logiotatidis Dave Dash
Giorgos Logiotatidis
Collaborator

No description provided.

Dave Dash

Please rebase your commits into a smaller set of commits, some of these seem to do things, and then undo things (like the fix path commits)

git rebase --interactive master

is a good interface for this, you can mark commits as "f" or "s" to squash, or simply fold into previous commits.

Giorgos Logiotatidis
Collaborator

Thanks for the rebase tip. Indeed I committed wrong documentation, which was fixed with a newer commit.

Now everything should be better, except this "Merge commit" which I can't figure a way not to push to you or delete. Any ideas?

Dave Dash davedash reopened this
Dave Dash

Also, you may want to talk about https://github.com/jbalogh/vending-machine/ - no worries if I'm asking a lot, this is definitely an improvement as is, but I think talking about using the vend command will make it 10x.

Giorgos Logiotatidis
Collaborator

Aha! I'll have a look at this and make the appropriate additions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.

Showing 1 changed file with 13 additions and 12 deletions. Show diff stats Hide diff stats

  1. +13 12 packages.rst
25 packages.rst
Source Rendered
@@ -15,7 +15,7 @@ of all your dependencies should exist in several places:
15 15 Ultimately your app code will run against the libraries under
16 16 vendor/vendor-local via mod_wsgi.
17 17
18   -Why requirements? For developement, you can use virtualenvs and pip to have a
  18 +Why requirements? For developement, you can use virtualenvs and pip to have a
19 19 tidy self-contained environment. If run from the Django runserver command, you
20 20 don't even need a web server.
21 21
@@ -63,7 +63,7 @@ compiled.txt vs prod.txt
63 63 ------------------------
64 64 If a Python library requires compilation, it should be recorded in compiled.txt.
65 65 These aren't as portable and cannot be shipped in the vendor library.
66   -For local development, it's nice to pip install these into a virtualenv. A
  66 +For local development, it's nice to pip install these into a virtualenv. A
67 67 common practise is to use virtual env **only** for compiled libraries and
68 68 vendor for the rest of your dependencies.
69 69
@@ -71,8 +71,8 @@ Adding new packages
71 71 -------------------
72 72
73 73 If we wanted to add a new dependency called ``cheeseballs`` to playdoh, you
74   -would add it to ``requirements/prod.txt``. If your library isn't used in
75   -production, then put it in ``requirements/dev.txt``. This makes it available
  74 +would add it to ``requirements/prod.txt``. If your library isn't used in
  75 +production, then put it in ``requirements/dev.txt``. This makes it available
76 76 to users installing into virtualenvs.
77 77
78 78 We also need to add the new package to the vendor-local lib, since that is
@@ -102,7 +102,7 @@ For hg repos that are not on PyPI, they can be installed with pip too
102 102 but omit the ``--home`` option and use the ``--src`` instead. For
103 103 example::
104 104
105   - pip install -I --src='vendor-local/src' \
  105 + pip install -I --src='vendor-local/src' \
106 106 -e hg+http://bitbucket.org/jespern/django-piston@default#egg=django-piston
107 107 cd vendor-local
108 108 git add src/django-piston
@@ -114,21 +114,22 @@ example::
114 114 ``vendor-local/vendor.pth``. See note below. For example::
115 115
116 116 echo src/django-piston >> vendor-local/vendor.pth
117   -
  117 + git commit vendor-local/vendor.pth
  118 +
118 119 git-based repositories
119 120 ~~~~~~~~~~~~~~~~~~~~~~
120 121
121 122 For a git-based package, add it as a git submodule::
122 123
123   - cd vendor-local
124   - git submodule add git://github.com/mozilla/cheeseballs.git src/cheeseballs
125   - git commit vendor.pth .gitmodules src/cheeseballs
  124 + git submodule add git://github.com/mozilla/cheeseballs.git vendor-local/src/cheeseballs
  125 + git commit .gitmodules vendor-local/src/cheeseballs
126 126
127 127 Further, you then need to update ``vendor-local/vendor.pth``. Python uses
128 128 ``.pth`` files to dynamically add directories to ``sys.path`` (`docs
129   -<http://docs.python.org/library/site.html>`_).
  129 +<http://docs.python.org/library/site.html>`_)::
130 130
131   -The file format is simple. Consult ``vendor/vendor.pth`` for reference.
  131 + echo src/cheeseballs >> vendor-local/vendor.pth
  132 + git commit vendor-local/vendor.pth
132 133
133 134 Some packages (like ``html5lib`` and ``selenium``) are troublesome, because
134 135 their source lives inside an extra subdirectory ``src/`` inside their checkout.
@@ -141,7 +142,7 @@ it worked.
141 142 Testing Your Vendor Change
142 143 --------------------------
143 144 It's critical that you test your app running under mod_wsgi. Although you
144   -may use runserver day to day, go ahead and run some code through WSGI to
  145 +may use runserver day to day, go ahead and run some code through WSGI to
145 146 prove vendor is setup properly. (throw an import into your view, etc)
146 147
147 148 Advanced Topics

Tip: You can add notes to lines in a file. Hover to the left of a line to make a note

Something went wrong with that request. Please try again.