diff --git a/docs/dev/env.rst b/docs/dev/env.rst index de67a9ae9..47d38139b 100644 --- a/docs/dev/env.rst +++ b/docs/dev/env.rst @@ -1,11 +1,13 @@ +############################ Your Development Environment -============================ +############################ .. image:: /_static/photos/33175624924_7febc46cc4_k_d.jpg +************ Text Editors -:::::::::::: +************ Just about anything that can edit plain text will work for writing Python code, however, using a more powerful editor may make your life a bit easier. @@ -138,9 +140,9 @@ Recommended for Python development is `Linter `_ combined with `linter-flake8 `_. - +**** IDEs -:::: +**** PyCharm / IntelliJ IDEA ----------------------- @@ -231,9 +233,9 @@ based on the Qt gui toolkit, integrating the Scintilla editor control. Eric is an open-source software project (GPLv3 licence) with more than ten years of active development. - +***************** Interpreter Tools -::::::::::::::::: +***************** Virtual Environments @@ -269,8 +271,10 @@ the creation of different environments, and also makes it possible to use the existing pyenv tools to switch to different environments based on environment variables or ``.python-version`` files. + +*********** Other Tools -::::::::::: +*********** IDLE ---- diff --git a/docs/dev/pip-virtualenv.rst b/docs/dev/pip-virtualenv.rst index 6971be876..144088585 100644 --- a/docs/dev/pip-virtualenv.rst +++ b/docs/dev/pip-virtualenv.rst @@ -1,12 +1,15 @@ .. _pip-virtualenv: +########################################### Further Configuration of Pip and Virtualenv -=========================================== +########################################### .. image:: /_static/photos/34018732105_f0e6758859_k_d.jpg + +*************************************************** Requiring an active virtual environment for ``pip`` ---------------------------------------------------- +*************************************************** By now it should be clear that using virtual environments is a great way to keep your development environment clean and keeping different projects' @@ -87,8 +90,10 @@ install packages globally by running ``gpip install``. You can change the name of the function to anything you like, just keep in mind that you will have to use that name when trying to install packages globally with pip. + +******************************* Caching packages for future use -------------------------------- +******************************* Every developer has preferred libraries and when you are working on a lot of different projects, you are bound to have some overlap between the libraries diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst index 11f924882..6d17c9ce0 100644 --- a/docs/dev/virtualenvs.rst +++ b/docs/dev/virtualenvs.rst @@ -1,7 +1,9 @@ .. _virtualenvironments-ref: + +############################# Pipenv & Virtual Environments -============================= +############################# .. image:: /_static/photos/35294660055_42c02b2316_k_d.jpg @@ -18,9 +20,9 @@ managing development and testing environments for any kind of project. .. Note:: This guide is written for Python 3, however, these instructions should work fine on Python 2.7—if you are still using it, for some reason. - +********************************* Make sure you've got Python & pip ---------------------------------- +********************************* Before you go any further, make sure you have Python and that it's available from your command line. You can check this by simply running: @@ -64,9 +66,9 @@ using your OS package manager, you may have to `install pip `_ provides a set of commands which makes working with virtual environments much @@ -346,7 +354,7 @@ To install (make sure **virtualenv** is already installed): In Windows, the default path for WORKON_HOME is %USERPROFILE%\Envs Basic Usage -~~~~~~~~~~~ +=========== 1. Create a virtual environment: @@ -390,7 +398,7 @@ can quickly switch between environments. $ rmvirtualenv venv Other useful commands -~~~~~~~~~~~~~~~~~~~~~ +===================== ``lsvirtualenv`` List all of the environments. @@ -407,14 +415,17 @@ Other useful commands `Full list of virtualenvwrapper commands `_. + +****************** virtualenv-burrito ------------------- +****************** With `virtualenv-burrito `_, you can have a working virtualenv + virtualenvwrapper environment in a single command. +******* autoenv -------- +******* When you ``cd`` into a directory containing a :file:`.env`, `autoenv `_ automagically activates the environment.