Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit bf98f51

Browse files
minrkminrk
committed
Merge pull request #5337 from ellisonbg/examples-reorg
Examples reorganization
2 parents 1ebcc42 + 94a4d14 commit bf98f51

155 files changed

Lines changed: 13066 additions & 14434 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

examples/notebooks/Cython Magics.ipynb renamed to examples/Builtin Extensions/Cython Magics.ipynb

File renamed without changes.

‎examples/Builtin Extensions/Index.ipynb‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
{
2+
"metadata": {
3+
"name": "",
4+
"signature": "sha256:a89ddd606f68e27067a5e2301a4d19a3c149131f4f07be4483a65979e26bebe0"
5+
},
6+
"nbformat": 3,
7+
"nbformat_minor": 0,
8+
"worksheets": [
9+
{
10+
"cells": [
11+
{
12+
"cell_type": "markdown",
13+
"metadata": {},
14+
"source": [
15+
"<img src=\"../images/ipython_logo.png\">"
16+
]
17+
},
18+
{
19+
"cell_type": "markdown",
20+
"metadata": {},
21+
"source": [
22+
"Back to the main [Index](../Index.ipynb)"
23+
]
24+
},
25+
{
26+
"cell_type": "heading",
27+
"level": 1,
28+
"metadata": {},
29+
"source": [
30+
"Builtin Extensions"
31+
]
32+
},
33+
{
34+
"cell_type": "markdown",
35+
"metadata": {},
36+
"source": [
37+
"IPython extensions allow custom magic commands to be shipped as standalone libraries. IPython includes a few extensions that define magic commands for working with code in other languages.\n",
38+
"\n",
39+
"<div class=\"alert\" style=\"margin: 10px\">\n",
40+
"We are in the process of moving these builtin extensions to their parent projects (Cython, oct2py and rpy2). Once this happens this documentation will move as well.\n",
41+
"</div>"
42+
]
43+
},
44+
{
45+
"cell_type": "heading",
46+
"level": 2,
47+
"metadata": {},
48+
"source": [
49+
"Tutorials"
50+
]
51+
},
52+
{
53+
"cell_type": "markdown",
54+
"metadata": {},
55+
"source": [
56+
"* [Cython Magics](Cython Magics.ipynb): magics for compiling and running Cython code in a cell\n",
57+
"* [Octave Magic](Octave Magic.ipynb): magics for running Octave code in a cell\n",
58+
"* [R Magics](R Magics.ipynb): magics for running R code in a cell"
59+
]
60+
}
61+
],
62+
"metadata": {}
63+
}
64+
]
65+
}

examples/notebooks/Octave Magic.ipynb renamed to examples/Builtin Extensions/Octave Magic.ipynb

File renamed without changes.

examples/notebooks/R Magics.ipynb renamed to examples/Builtin Extensions/R Magics.ipynb

File renamed without changes.

‎examples/Customization/Index.ipynb‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
{
2+
"metadata": {
3+
"name": "",
4+
"signature": "sha256:de8cb1aff3da9097ba3fc7afab4327fc589f2bb1c154feeeb5ed97c87e37486f"
5+
},
6+
"nbformat": 3,
7+
"nbformat_minor": 0,
8+
"worksheets": [
9+
{
10+
"cells": [
11+
{
12+
"cell_type": "markdown",
13+
"metadata": {},
14+
"source": [
15+
"<img src=\"../images/ipython_logo.png\">"
16+
]
17+
},
18+
{
19+
"cell_type": "markdown",
20+
"metadata": {},
21+
"source": [
22+
"Back to the main [Index](../Index.ipynb)"
23+
]
24+
},
25+
{
26+
"cell_type": "heading",
27+
"level": 1,
28+
"metadata": {},
29+
"source": [
30+
"Customization"
31+
]
32+
},
33+
{
34+
"cell_type": "markdown",
35+
"metadata": {},
36+
"source": [
37+
"IPython has rich APIs for customization. Many behaviors of the different IPython applications can be configured using command line arguments or configuration files. IPython's core syntax and command line features can also be customized through input filters, custom magic commands, etc."
38+
]
39+
},
40+
{
41+
"cell_type": "heading",
42+
"level": 2,
43+
"metadata": {},
44+
"source": [
45+
"Tutorials"
46+
]
47+
},
48+
{
49+
"cell_type": "markdown",
50+
"metadata": {},
51+
"source": [
52+
"Coming soon."
53+
]
54+
},
55+
{
56+
"cell_type": "heading",
57+
"level": 2,
58+
"metadata": {},
59+
"source": [
60+
"Examples"
61+
]
62+
},
63+
{
64+
"cell_type": "markdown",
65+
"metadata": {},
66+
"source": [
67+
"Coming soon."
68+
]
69+
},
70+
{
71+
"cell_type": "heading",
72+
"level": 2,
73+
"metadata": {},
74+
"source": [
75+
"Non-notebook examples"
76+
]
77+
},
78+
{
79+
"cell_type": "markdown",
80+
"metadata": {},
81+
"source": [
82+
"This directory also contains examples that are regular Python (`.py`) files."
83+
]
84+
},
85+
{
86+
"cell_type": "code",
87+
"collapsed": false,
88+
"input": [
89+
"%run ../utils/list_pyfiles.ipy"
90+
],
91+
"language": "python",
92+
"metadata": {},
93+
"outputs": [
94+
{
95+
"html": [
96+
"<a href='appconfig.py' target='_blank'>appconfig.py</a><br>"
97+
],
98+
"metadata": {},
99+
"output_type": "display_data",
100+
"text": [
101+
"/Users/bgranger/Documents/Computing/IPython/code/ipython/examples/Customization/appconfig.py"
102+
]
103+
}
104+
],
105+
"prompt_number": 1
106+
}
107+
],
108+
"metadata": {}
109+
}
110+
]
111+
}

examples/core/appconfig.py renamed to examples/Customization/appconfig.py

File renamed without changes.

‎examples/Embedding/Index.ipynb‎

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
{
2+
"metadata": {
3+
"name": "",
4+
"signature": "sha256:627cdf03b8de558c9344f9d1e8f0beeb2448e37e492d676e6db7b07d33251a2b"
5+
},
6+
"nbformat": 3,
7+
"nbformat_minor": 0,
8+
"worksheets": [
9+
{
10+
"cells": [
11+
{
12+
"cell_type": "markdown",
13+
"metadata": {},
14+
"source": [
15+
"<img src=\"../images/ipython_logo.png\">"
16+
]
17+
},
18+
{
19+
"cell_type": "markdown",
20+
"metadata": {},
21+
"source": [
22+
"Back to the main [Index](../Index.ipynb)"
23+
]
24+
},
25+
{
26+
"cell_type": "heading",
27+
"level": 1,
28+
"metadata": {},
29+
"source": [
30+
"Embedding IPython Into Other Applications"
31+
]
32+
},
33+
{
34+
"cell_type": "markdown",
35+
"metadata": {},
36+
"source": [
37+
"The architecture of IPython is built with reusable components. These components include:\n",
38+
"\n",
39+
"* The configuration system for processing command line arguments and configuration files\n",
40+
"* The IPython `InteractiveShell` object that provides the core interactive features across the entire code base\n",
41+
"* The IPython kernel, which provides the capabilities of the `InteractiveShell` object over a ZeroMQ/JSON based message protocol to various frontends\n",
42+
"* The IPython frontends (Notebook, Qt Console, Console, Terminal)\n",
43+
"\n",
44+
"These components can be embedded into other applications."
45+
]
46+
},
47+
{
48+
"cell_type": "heading",
49+
"level": 2,
50+
"metadata": {},
51+
"source": [
52+
"Tutorials"
53+
]
54+
},
55+
{
56+
"cell_type": "markdown",
57+
"metadata": {},
58+
"source": [
59+
"Coming soon."
60+
]
61+
},
62+
{
63+
"cell_type": "heading",
64+
"level": 2,
65+
"metadata": {},
66+
"source": [
67+
"Examples"
68+
]
69+
},
70+
{
71+
"cell_type": "markdown",
72+
"metadata": {},
73+
"source": [
74+
"Coming soon."
75+
]
76+
},
77+
{
78+
"cell_type": "heading",
79+
"level": 2,
80+
"metadata": {},
81+
"source": [
82+
"Non-notebook examples"
83+
]
84+
},
85+
{
86+
"cell_type": "markdown",
87+
"metadata": {},
88+
"source": [
89+
"This directory also contains examples that are regular Python (`.py`) files."
90+
]
91+
},
92+
{
93+
"cell_type": "code",
94+
"collapsed": false,
95+
"input": [
96+
"%run ../utils/list_pyfiles.ipy"
97+
],
98+
"language": "python",
99+
"metadata": {},
100+
"outputs": [
101+
{
102+
"html": [
103+
"<a href='embed_class_long.py' target='_blank'>embed_class_long.py</a><br>"
104+
],
105+
"metadata": {},
106+
"output_type": "display_data",
107+
"text": [
108+
"/Users/bgranger/Documents/Computing/IPython/code/ipython/examples/Embedding/embed_class_long.py"
109+
]
110+
},
111+
{
112+
"html": [
113+
"<a href='embed_class_short.py' target='_blank'>embed_class_short.py</a><br>"
114+
],
115+
"metadata": {},
116+
"output_type": "display_data",
117+
"text": [
118+
"/Users/bgranger/Documents/Computing/IPython/code/ipython/examples/Embedding/embed_class_short.py"
119+
]
120+
},
121+
{
122+
"html": [
123+
"<a href='embed_function.py' target='_blank'>embed_function.py</a><br>"
124+
],
125+
"metadata": {},
126+
"output_type": "display_data",
127+
"text": [
128+
"/Users/bgranger/Documents/Computing/IPython/code/ipython/examples/Embedding/embed_function.py"
129+
]
130+
},
131+
{
132+
"html": [
133+
"<a href='inprocess_qtconsole.py' target='_blank'>inprocess_qtconsole.py</a><br>"
134+
],
135+
"metadata": {},
136+
"output_type": "display_data",
137+
"text": [
138+
"/Users/bgranger/Documents/Computing/IPython/code/ipython/examples/Embedding/inprocess_qtconsole.py"
139+
]
140+
},
141+
{
142+
"html": [
143+
"<a href='inprocess_terminal.py' target='_blank'>inprocess_terminal.py</a><br>"
144+
],
145+
"metadata": {},
146+
"output_type": "display_data",
147+
"text": [
148+
"/Users/bgranger/Documents/Computing/IPython/code/ipython/examples/Embedding/inprocess_terminal.py"
149+
]
150+
},
151+
{
152+
"html": [
153+
"<a href='internal_ipkernel.py' target='_blank'>internal_ipkernel.py</a><br>"
154+
],
155+
"metadata": {},
156+
"output_type": "display_data",
157+
"text": [
158+
"/Users/bgranger/Documents/Computing/IPython/code/ipython/examples/Embedding/internal_ipkernel.py"
159+
]
160+
},
161+
{
162+
"html": [
163+
"<a href='ipkernel_qtapp.py' target='_blank'>ipkernel_qtapp.py</a><br>"
164+
],
165+
"metadata": {},
166+
"output_type": "display_data",
167+
"text": [
168+
"/Users/bgranger/Documents/Computing/IPython/code/ipython/examples/Embedding/ipkernel_qtapp.py"
169+
]
170+
},
171+
{
172+
"html": [
173+
"<a href='ipkernel_wxapp.py' target='_blank'>ipkernel_wxapp.py</a><br>"
174+
],
175+
"metadata": {},
176+
"output_type": "display_data",
177+
"text": [
178+
"/Users/bgranger/Documents/Computing/IPython/code/ipython/examples/Embedding/ipkernel_wxapp.py"
179+
]
180+
}
181+
],
182+
"prompt_number": 1
183+
}
184+
],
185+
"metadata": {}
186+
}
187+
]
188+
}

examples/core/example-embed.py renamed to examples/Embedding/embed_class_long.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
Please see the documentation in the IPython.Shell module for more details.
55
6-
The accompanying file example-embed-short.py has quick code fragments for
6+
The accompanying file embed_class_short.py has quick code fragments for
77
embedding which you can cut and paste in your code once you understand how
88
things work.
99
@@ -133,5 +133,3 @@ def bar(n):
133133
bar('spam')
134134

135135
print('Main program finished. Bye!')
136-
137-
#********************** End of file <example-embed.py> ***********************

0 commit comments

Comments
 (0)