mirror of
https://github.com/kennethreitz/python-guide.git
synced 2026-06-05 14:50:19 +00:00
Kenneth Reitz
231 lines
7.7 KiB
ReStructuredText
231 lines
7.7 KiB
ReStructuredText
Your Development Environment
|
|
============================
|
|
|
|
|
|
Text Editors
|
|
::::::::::::
|
|
|
|
Just about anything which can edit plain text will work for writing Python code,
|
|
however, using a more powerful editor may make your life a bit easier.
|
|
|
|
|
|
VIM
|
|
---
|
|
|
|
|
|
There exist a couple of plugins and settings for the VIM editor to aid python
|
|
development. If you only develop in Python, a good start is to set the default
|
|
settings for indentation and linewrapping to values compliant with PEP8::
|
|
|
|
set textwidth=79
|
|
set shiftwidth=4
|
|
set tabstop=4
|
|
set expandtab
|
|
set softtabstop=4
|
|
set shiftround
|
|
|
|
With these settings newlines are inserted after 79 characters and indentation
|
|
is set to 4 spaces per tab. If you also use VIM for other languages, there is a
|
|
handy plugin at indent_, which handles indentation settings for python source
|
|
files.
|
|
Additionally there is also a handy syntax plugin at syntax_ featuring some
|
|
improvements over the syntax file included in VIM 6.1.
|
|
|
|
These plugins supply you with a basic environment for developing in Python.
|
|
However in order to improve the programming flow we also want to continually
|
|
check for PEP8 compliance and check syntax. Luckily there exist PEP8_ and
|
|
Pyflakes_ to do this for you. If your VIM is compiled with `+python` you can
|
|
also utilize some very handy plugins to do these checks from within the editor.
|
|
For PEP8 checking install vim-pep8_. Now you can map the vim function
|
|
`Pep8()` to any hotkey or action you want. Similarly for pyflakes you can
|
|
install vim-pyflakes_. Now you can map `Pyflakes()` like the PEP8 function and
|
|
have it called quickly. Both plugins will display errors in a quickfix list and
|
|
provide an easy way to jump to the corresponding line. A very handy setting is
|
|
calling these functions whenever a buffer is saved. In order to do this, enter
|
|
the following lines into your vimrc::
|
|
|
|
autocmd BufWritePost *.py call Pyflakes()
|
|
autocmd BufWritePost *.py call Pep8()
|
|
|
|
|
|
.. _indent: http://www.vim.org/scripts/script.php?script_id=974
|
|
.. _syntax: http://www.vim.org/scripts/script.php?script_id=790
|
|
.. _Pyflakes: http://pypi.python.org/pypi/pyflakes/
|
|
.. _vim-pyflakes: https://github.com/nvie/vim-pyflakes
|
|
.. _PEP8: http://pypi.python.org/pypi/pep8/
|
|
.. _vim-pep8: https://github.com/nvie/vim-pep8
|
|
|
|
.. todo:: add supertab notes
|
|
|
|
TextMate
|
|
--------
|
|
|
|
"`TextMate <http://macromates.com/>`_ brings Apple's approach to operating systems into the world of text editors. By bridging UNIX underpinnings and GUI, TextMate cherry-picks the best of both worlds to the benefit of expert scripters and novice users alike."
|
|
|
|
Sublime Text
|
|
------------
|
|
|
|
"`Sublime Text <http://www.sublimetext.com/>`_ is a sophisticated text editor
|
|
for code, html and prose. You'll love the slick user interface and
|
|
extraordinary features."
|
|
|
|
Sublime Text has excellent support for editing Python code and uses Python for
|
|
its plugin API.
|
|
|
|
`Sublime Text 2 <http://www.sublimetext.com/blog/articles/sublime-text-2-beta>`_ is currently in beta.
|
|
|
|
IDEs
|
|
::::
|
|
|
|
PyCharm / IntelliJ IDEA
|
|
-----------------------
|
|
|
|
`PyCharm <http://www.jetbrains.com/pycharm/>`_ is developed by JetBrains, also known for IntelliJ IDEA. Both share the same code base and most of PyCharm's features can be brought to IntelliJ with the free `Python Plug-In <http://plugins.intellij.net/plugin/?id=631/>`_.
|
|
|
|
Eclipse
|
|
-------
|
|
|
|
The most popular Eclipse plugin for Python development is Aptana's
|
|
`PyDev <http://pydev.org>`_.
|
|
|
|
|
|
Komodo IDE
|
|
-----------
|
|
`Komodo IDE <http://www.activestate.com/komodo-ide>`_ is developed by ActiveState and is a commerical IDE for Windows, Mac
|
|
and Linux.
|
|
|
|
Spyder
|
|
------
|
|
|
|
`Spyder <http://code.google.com/p/spyderlib/>`_ an IDE specifically geared toward working with scientific python libraries (namely `Scipy <http://www.scipy.org/>`_).
|
|
Includes integration with pyflakes_, `pylint <http://www.logilab.org/857>`_,
|
|
and `rope <http://rope.sourceforge.net/>`_.
|
|
|
|
Spyder is open-source (free), offers code completion, syntax highlighting, class and function browser, and object inspection.
|
|
|
|
|
|
|
|
Interpreter Tools
|
|
:::::::::::::::::
|
|
|
|
|
|
virtualenv
|
|
----------
|
|
|
|
Virtualenv is a tool to keep the dependencies required by different projects in separate places, by creating virtual Python environments for them.
|
|
It solves the "Project X depends on version 1.x but, Project Y needs 4.x" dilemma and keeps your global site-packages directory clean and manageable.
|
|
|
|
`virtualenv <http://www.virtualenv.org/en/latest/index.html>`_ creates
|
|
a folder which contains all the necessary executables to contain the
|
|
packages that a Python project would need. An example workflow is given.
|
|
|
|
Install virtualenv::
|
|
|
|
$ pip install virtualenv
|
|
|
|
|
|
Create a virtual environment for a project::
|
|
|
|
$ cd my_project
|
|
$ virtualenv venv
|
|
|
|
``virtualenv venv`` will create a folder in the currect directory
|
|
which will contain the Python executable files, and a copy of the ``pip``
|
|
library which you can use to install other packages. The name of the
|
|
virtual environment (in this case, it was ``venv``) can be anything;
|
|
omitting the name will place the files in the current directory instead.
|
|
|
|
In order the start using the virtual environment, run::
|
|
|
|
$ source venv/bin/activate
|
|
|
|
|
|
The name of the current virtual environment will now appear on the left
|
|
of the prompt (e.g. ``(venv)Your-Computer:your_project UserName$``) to
|
|
let you know that it's active. From now on, any package that you install
|
|
using ``pip`` will be placed in the venv folder, isolated from the global
|
|
Python installation. Install packages as usual::
|
|
|
|
$ pip install requests
|
|
|
|
To stop using an environment simply type ``deactivate``. To remove the
|
|
environment, just remove the directory it was installed into. (In this
|
|
case, it would be ``rm -rf venv``).
|
|
|
|
Other Notes
|
|
~~~~~~~~~~~
|
|
|
|
Running ``virtualenv`` with the option ``--no-site-packages`` will not
|
|
include the packages that are installed globally. This can be useful
|
|
for keeping the package list clean in case it needs to be accessed later.
|
|
|
|
In order to keep your environment consistent, it's a good idea to "freeze"
|
|
the current state of the environment packages. To do this, run
|
|
|
|
::
|
|
|
|
$ pip freeze > requirements.txt
|
|
|
|
This will create a ``requirements.txt`` file, which contains a simple
|
|
list of all the packages in the current environment, and their respective
|
|
versions. Later, when a different developer (or you, if you need to re-
|
|
create the environment) can install the same packages, with the same
|
|
versions by running
|
|
|
|
::
|
|
|
|
$ pip install -r requirements.txt
|
|
|
|
This can help ensure consistency across installations, across deployments,
|
|
and across developers.
|
|
|
|
Lastly, remember to exclude the virtual environment folder from source
|
|
control by adding it to the ignore list.
|
|
|
|
virtualenvwrapper
|
|
-----------------
|
|
|
|
`Virtualenvwrapper <http://pypi.python.org/pypi/virtualenvwrapper>`_ makes virtualenv a pleasure to use by wrapping the command line API with a nicer CLI.
|
|
|
|
::
|
|
|
|
$ pip install virtualenvwrapper
|
|
|
|
|
|
Put this into your `~/.bash_profile` (Linux/Mac) file:
|
|
|
|
::
|
|
|
|
$ export VIRTUALENVWRAPPER_VIRTUALENV_ARGS='--no-site-packages'
|
|
|
|
This will prevent your virtualenvs from relying on your (global) site packages directory, so that they are completely separate..
|
|
|
|
Other Tools
|
|
:::::::::::
|
|
|
|
IPython
|
|
-------
|
|
|
|
`IPython <http://ipython.org/>`_ provides a rich toolkit to help you make the most out of using Python interactively. Its main components are:
|
|
|
|
* Powerful Python shells (terminal- and Qt-based).
|
|
* A web-based notebook with the same core features but support for rich media, text, code, mathematical expressions and inline plots.
|
|
* Support for interactive data visualization and use of GUI toolkits.
|
|
* Flexible, embeddable interpreters to load into your own projects.
|
|
* Tools for high level and interactive parallel computing.
|
|
|
|
::
|
|
|
|
$ pip install ipython
|
|
|
|
|
|
|
|
BPython
|
|
-------
|
|
|
|
::
|
|
|
|
$ pip install bpython
|
|
|
|
|