Docs scaffold to cookiecutter #2878
Conversation
- unwrap - fix grammar - link should be generic to avoid release maintenance
- etc. to and so on
- no default templating systems, but use Chameleon
- add cookiecutter - deprecate scaffold
- project src files are now in the properly named folder `pyramidtut` - add glossary term `coverage`
- update src files
- correct path to pyramidtut/
- update src files
- update src files
- update src files
…nto docs-scaffold-to-cookiecutter
| people download from PyPI. | ||
| removing 'pyramidtut-0.0' (and everything under it) | ||
|
|
||
| Note that this command creates a tarball in the ``dist`` subdirectory named ``pyramidtut-0.0.tar.gz``. You can send this file to your friends to show them your cool new application. They should be able to install it by pointing the ``easy_install`` command directly at it. Or you can upload it to `PyPI <https://pypi.python.org/pypi>`_ and share it with the rest of the world, where it can be downloaded via ``easy_install`` remotely like any other package people download from PyPI. |
There was a problem hiding this comment.
Talk about pip here instead of easy_install. pip install pyramidtut-0.0.tar.gz should work fine.
There was a problem hiding this comment.
Fixed in stevepiercy@5d9fd5f
| .. versionadded:: 1.8 | ||
|
|
||
| .. seealso:: See also :term:`scaffold`. |
There was a problem hiding this comment.
Can we get a ref in here to somewhere in the docs containing a table of the 3 official cookiecutters?
There was a problem hiding this comment.
Added in stevepiercy@e7b12f6 and it will be added in the updated scaffolding.rst when I get to it.
|
|
||
| Test the models | ||
| =============== | ||
| --------------- |
There was a problem hiding this comment.
Why did the sections get changed to --- from ===? The latter was the correct subsection.
There was a problem hiding this comment.
Change deferred to Style Guide
| @@ -3,7 +3,7 @@ | |||
|
|
|||
| # Recommended naming convention used by Alembic, as various different database | |||
| # providers will autogenerate vastly different names making migrations more | |||
| # difficult. See: http://alembic.zzzcomputing.com/en/latest/naming.html | |||
| # difficult. See: http://alembic.readthedocs.org/en/latest/naming.html | |||
There was a problem hiding this comment.
This is not the correct URL. Perhaps the cookiecutter is incorrect.
There was a problem hiding this comment.
| @@ -5,7 +5,7 @@ | |||
|
|
|||
| # import or define all models here to ensure they are attached to the | |||
| # Base.metadata prior to any initialization routines | |||
| from .mymodel import MyModel # noqa | |||
| from .mymodel import MyModel # flake8: noqa | |||
There was a problem hiding this comment.
There should be 2 spaces here. Again probably the cookiecutter is out of date.
There was a problem hiding this comment.
|
|
||
| Success executing this command will end with a line to the console something | ||
| like this:: | ||
| Success executing this command will end with a line to the console something like the following. |
There was a problem hiding this comment.
Sentence should end with : instead of a period.
|
|
||
| Only the highlighted line needs to be added. | ||
|
|
||
| .. note:: | ||
|
|
||
| We are using the ``bcrypt`` package from PyPI to hash our passwords securely. There are other one-way hash algorithms for passwords if bcrypt is an issue on your system. Just make sure that it's an algorithm approved for storing passwords versus a generic one-way hash. |
There was a problem hiding this comment.
Make this another ref to the bcrypt link instead of just monospacing it. You already added the ref at the bottom of the file.
There was a problem hiding this comment.
I rearranged this a bit. It flows better now, and only the first instance of bcrypt is hyperlinked.
|
I put the do-not-merge label on this PR because I tried to do too many extraneous things at once, and it should be closed eventually. New plan:
|
This PR includes work on:
Docs may be viewed starting at:
http://pyramid-stevepiercy.readthedocs.io/en/docs-scaffold-to-cookiecutter/tutorials/wiki/index.html