Skip to content

Corrections to instructions, terminology, and docs link - #94

Merged
mattmakai merged 1 commit into
mattmakai:gh-pagesfrom
stevepiercy:patch-2
Jun 21, 2016
Merged

Corrections to instructions, terminology, and docs link#94
mattmakai merged 1 commit into
mattmakai:gh-pagesfrom
stevepiercy:patch-2

Conversation

@stevepiercy

Copy link
Copy Markdown
Contributor

Thank you for the write-up! Following are my suggestions for corrections.

  • Pin version of Pyramid to 1.7, else pip will install the latest release on PyPI. This will future-proof your instructions and make them consistent with your Required Tools.
  • virtualenv and pip do not need to be installed with Python 3.5 because it now includes venv and pip. You do, however, need to update both. You'll need to update your PNG, though.
  • Use python3 -m venv to create a virtual environment, as this is now the recommended way, although it is not yet documented, per https://bugs.python.org/issue27285
  • Use proper term for a Python virtual environment. venv, virtualenv, and pyvenv (which is merely a script that wraps venv) are all implementations of a virtual environment.
  • Use official, canonical URL for Pyramid docs.

Although I did not include it in this PR, I thought I would mention that Pyramid comes with three scaffolds—starter, alchemy, and zodb—the latter two of which have full tutorials at http://docs.pylonsproject.org/projects/pyramid/en/latest/tutorials/wiki2/index.html and http://docs.pylonsproject.org/projects/pyramid/en/latest/tutorials/wiki/index.html Additionally, we now have four cookiecutters that perform a similar function to the scaffolds, but go further by simplifying the entire installation process. Those are located at https://github.com/Pylons/?utf8=%E2%9C%93&query=cookiecutter

Thank you for the write-up! Following are my suggestions for corrections.

- Pin version of Pyramid to 1.7, else pip will install the latest release on PyPI. This will future-proof your instructions and make them consistent with your Required Tools.
- virtualenv and pip do not need to be installed with Python 3.5 because it now includes venv and pip. You do, however, need to update both. You'll need to update your PNG, though.
- Use `python3 -m venv` to create a virtual environment, as this is now the recommended way, although it is not yet documented, per https://bugs.python.org/issue27285
- Use proper term for a Python virtual environment. venv, virtualenv, and pyvenv (which is merely a script that wraps venv) are all implementations of a virtual environment.
- Use official, canonical URL for Pyramid docs.

Although I did not include it in this PR, I thought I would mention that Pyramid comes with three scaffolds—starter, alchemy, and zodb—the latter two of which have full tutorials at http://docs.pylonsproject.org/projects/pyramid/en/latest/tutorials/wiki2/index.html and http://docs.pylonsproject.org/projects/pyramid/en/latest/tutorials/wiki/index.html Additionally, we now have four cookiecutters that perform a similar function to the scaffolds, but go further by simplifying the entire installation process. Those are located at https://github.com/Pylons/?utf8=%E2%9C%93&query=cookiecutter
@mattmakai

Copy link
Copy Markdown
Owner

Wow, this is awesome! Thank you so much for taking the time to make these changes @stevepiercy. I'm merging this one and will do some more reading based on your links. It's pretty clear my lack of time with Pyramid created some weaknesses in this post. I really appreciate the helping hand making this post better.

@mattmakai
mattmakai merged commit ee917a7 into mattmakai:gh-pages Jun 21, 2016
@stevepiercy

Copy link
Copy Markdown
Contributor Author

You're welcome! I'm glad to help with Pyramid docs.

BTW, if you have any public projects that use Pyramid, I recently pushed out this page:
https://trypyramid.com/community-powered-by-pyramid.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants