File: projects.rst

package info (click to toggle)
spyder 3.1.3+dfsg1-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 7,552 kB
  • ctags: 4,851
  • sloc: python: 41,887; xml: 220; makefile: 23; sh: 6
file content (69 lines) | stat: -rw-r--r-- 2,095 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
Projects
========

Spyder allows users to associate a given directory with a project. This has two
main advantages:

1. Projects remember the list of open files in Editor. This permits to easily
   work on several coding efforts at the same time.
2. The project's path is added to the list of paths Python looks modules for, so
   that modules developed as part of a project can be easily imported in any
   console.

To create a project, it is necessary to select the *New Project* entry from the
*Projects* menu:

|

.. image:: images/new_project.png
   :align: center

|

When a project is activated, the *Project explorer* pane is shown, which
presents a tree view structure of the current project

|

.. image:: images/projectexplorer.png
   :align: center

|

Through this pane it is possible to make several operations on the files that
belong to project

|

.. image:: images/projectexplorer2.png
   :align: center

|

.. note:: Projects are completely optional and not imposed on users, i.e. users
   can work without creating any project.


Version Control Integration
---------------------------

Spyder has limited integration with Git_ and Mercurial_. Commit and browse
commands are available by right-clicking on relevant files that reside within
an already initialized repository. This menu assume that certain commands are
available on the system path.

* For Mercurial repositories, TortoiseHG_ must be installed, and either ``thg``
  or ``hgtk`` must be on the system path.
* For git repositories, the commands ``git`` and ``gitk`` must be on the
  system path. For Windows systems, the `Git for Windows`_ package provides a
  convenient installer and the option to place common git commands on the
  system path without creating conflicts with Windows system tools.
  The second option in the dialog below is generally a safe approach.

.. image:: images/git_install_dialog.png
   :align: center

.. _Git: http://git-scm.com/
.. _Mercurial: http://mercurial.selenic.com/
.. _TortoiseHg: http://tortoisehg.bitbucket.org/
.. _Git for Windows: https://git-for-windows.github.io/