aipython-shell 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- aipython_shell-0.2.0/.gitignore +6 -0
- aipython_shell-0.2.0/LICENSE +373 -0
- aipython_shell-0.2.0/PKG-INFO +256 -0
- aipython_shell-0.2.0/README.md +229 -0
- aipython_shell-0.2.0/aipython/__init__.py +28 -0
- aipython_shell-0.2.0/aipython/cli.py +17 -0
- aipython_shell-0.2.0/aipython/config.py +82 -0
- aipython_shell-0.2.0/aipython/context.py +198 -0
- aipython_shell-0.2.0/aipython/detect.py +81 -0
- aipython_shell-0.2.0/aipython/llm.py +238 -0
- aipython_shell-0.2.0/aipython/log.py +72 -0
- aipython_shell-0.2.0/aipython/shell.py +208 -0
- aipython_shell-0.2.0/pyproject.toml +49 -0
- aipython_shell-0.2.0/tests/conftest.py +9 -0
- aipython_shell-0.2.0/tests/test_config.py +73 -0
- aipython_shell-0.2.0/tests/test_detect.py +41 -0
- aipython_shell-0.2.0/tests/test_shell.py +202 -0
|
@@ -0,0 +1,373 @@
|
|
|
1
|
+
Mozilla Public License Version 2.0
|
|
2
|
+
==================================
|
|
3
|
+
|
|
4
|
+
1. Definitions
|
|
5
|
+
--------------
|
|
6
|
+
|
|
7
|
+
1.1. "Contributor"
|
|
8
|
+
means each individual or legal entity that creates, contributes to
|
|
9
|
+
the creation of, or owns Covered Software.
|
|
10
|
+
|
|
11
|
+
1.2. "Contributor Version"
|
|
12
|
+
means the combination of the Contributions of others (if any) used
|
|
13
|
+
by a Contributor and that particular Contributor's Contribution.
|
|
14
|
+
|
|
15
|
+
1.3. "Contribution"
|
|
16
|
+
means Covered Software of a particular Contributor.
|
|
17
|
+
|
|
18
|
+
1.4. "Covered Software"
|
|
19
|
+
means Source Code Form to which the initial Contributor has attached
|
|
20
|
+
the notice in Exhibit A, the Executable Form of such Source Code
|
|
21
|
+
Form, and Modifications of such Source Code Form, in each case
|
|
22
|
+
including portions thereof.
|
|
23
|
+
|
|
24
|
+
1.5. "Incompatible With Secondary Licenses"
|
|
25
|
+
means
|
|
26
|
+
|
|
27
|
+
(a) that the initial Contributor has attached the notice described
|
|
28
|
+
in Exhibit B to the Covered Software; or
|
|
29
|
+
|
|
30
|
+
(b) that the Covered Software was made available under the terms of
|
|
31
|
+
version 1.1 or earlier of the License, but not also under the
|
|
32
|
+
terms of a Secondary License.
|
|
33
|
+
|
|
34
|
+
1.6. "Executable Form"
|
|
35
|
+
means any form of the work other than Source Code Form.
|
|
36
|
+
|
|
37
|
+
1.7. "Larger Work"
|
|
38
|
+
means a work that combines Covered Software with other material, in
|
|
39
|
+
a separate file or files, that is not Covered Software.
|
|
40
|
+
|
|
41
|
+
1.8. "License"
|
|
42
|
+
means this document.
|
|
43
|
+
|
|
44
|
+
1.9. "Licensable"
|
|
45
|
+
means having the right to grant, to the maximum extent possible,
|
|
46
|
+
whether at the time of the initial grant or subsequently, any and
|
|
47
|
+
all of the rights conveyed by this License.
|
|
48
|
+
|
|
49
|
+
1.10. "Modifications"
|
|
50
|
+
means any of the following:
|
|
51
|
+
|
|
52
|
+
(a) any file in Source Code Form that results from an addition to,
|
|
53
|
+
deletion from, or modification of the contents of Covered
|
|
54
|
+
Software; or
|
|
55
|
+
|
|
56
|
+
(b) any new file in Source Code Form that contains any Covered
|
|
57
|
+
Software.
|
|
58
|
+
|
|
59
|
+
1.11. "Patent Claims" of a Contributor
|
|
60
|
+
means any patent claim(s), including without limitation, method,
|
|
61
|
+
process, and apparatus claims, in any patent Licensable by such
|
|
62
|
+
Contributor that would be infringed, but for the grant of the
|
|
63
|
+
License, by the making, using, selling, offering for sale, having
|
|
64
|
+
made, import, or transfer of either its Contributions or its
|
|
65
|
+
Contributor Version.
|
|
66
|
+
|
|
67
|
+
1.12. "Secondary License"
|
|
68
|
+
means either the GNU General Public License, Version 2.0, the GNU
|
|
69
|
+
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
70
|
+
Public License, Version 3.0, or any later versions of those
|
|
71
|
+
licenses.
|
|
72
|
+
|
|
73
|
+
1.13. "Source Code Form"
|
|
74
|
+
means the form of the work preferred for making modifications.
|
|
75
|
+
|
|
76
|
+
1.14. "You" (or "Your")
|
|
77
|
+
means an individual or a legal entity exercising rights under this
|
|
78
|
+
License. For legal entities, "You" includes any entity that
|
|
79
|
+
controls, is controlled by, or is under common control with You. For
|
|
80
|
+
purposes of this definition, "control" means (a) the power, direct
|
|
81
|
+
or indirect, to cause the direction or management of such entity,
|
|
82
|
+
whether by contract or otherwise, or (b) ownership of more than
|
|
83
|
+
fifty percent (50%) of the outstanding shares or beneficial
|
|
84
|
+
ownership of such entity.
|
|
85
|
+
|
|
86
|
+
2. License Grants and Conditions
|
|
87
|
+
--------------------------------
|
|
88
|
+
|
|
89
|
+
2.1. Grants
|
|
90
|
+
|
|
91
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
92
|
+
non-exclusive license:
|
|
93
|
+
|
|
94
|
+
(a) under intellectual property rights (other than patent or trademark)
|
|
95
|
+
Licensable by such Contributor to use, reproduce, make available,
|
|
96
|
+
modify, display, perform, distribute, and otherwise exploit its
|
|
97
|
+
Contributions, either on an unmodified basis, with Modifications, or
|
|
98
|
+
as part of a Larger Work; and
|
|
99
|
+
|
|
100
|
+
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
|
101
|
+
for sale, have made, import, and otherwise transfer either its
|
|
102
|
+
Contributions or its Contributor Version.
|
|
103
|
+
|
|
104
|
+
2.2. Effective Date
|
|
105
|
+
|
|
106
|
+
The licenses granted in Section 2.1 with respect to any Contribution
|
|
107
|
+
become effective for each Contribution on the date the Contributor first
|
|
108
|
+
distributes such Contribution.
|
|
109
|
+
|
|
110
|
+
2.3. Limitations on Grant Scope
|
|
111
|
+
|
|
112
|
+
The licenses granted in this Section 2 are the only rights granted under
|
|
113
|
+
this License. No additional rights or licenses will be implied from the
|
|
114
|
+
distribution or licensing of Covered Software under this License.
|
|
115
|
+
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
116
|
+
Contributor:
|
|
117
|
+
|
|
118
|
+
(a) for any code that a Contributor has removed from Covered Software;
|
|
119
|
+
or
|
|
120
|
+
|
|
121
|
+
(b) for infringements caused by: (i) Your and any other third party's
|
|
122
|
+
modifications of Covered Software, or (ii) the combination of its
|
|
123
|
+
Contributions with other software (except as part of its Contributor
|
|
124
|
+
Version); or
|
|
125
|
+
|
|
126
|
+
(c) under Patent Claims infringed by Covered Software in the absence of
|
|
127
|
+
its Contributions.
|
|
128
|
+
|
|
129
|
+
This License does not grant any rights in the trademarks, service marks,
|
|
130
|
+
or logos of any Contributor (except as may be necessary to comply with
|
|
131
|
+
the notice requirements in Section 3.4).
|
|
132
|
+
|
|
133
|
+
2.4. Subsequent Licenses
|
|
134
|
+
|
|
135
|
+
No Contributor makes additional grants as a result of Your choice to
|
|
136
|
+
distribute the Covered Software under a subsequent version of this
|
|
137
|
+
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
138
|
+
permitted under the terms of Section 3.3).
|
|
139
|
+
|
|
140
|
+
2.5. Representation
|
|
141
|
+
|
|
142
|
+
Each Contributor represents that the Contributor believes its
|
|
143
|
+
Contributions are its original creation(s) or it has sufficient rights
|
|
144
|
+
to grant the rights to its Contributions conveyed by this License.
|
|
145
|
+
|
|
146
|
+
2.6. Fair Use
|
|
147
|
+
|
|
148
|
+
This License is not intended to limit any rights You have under
|
|
149
|
+
applicable copyright doctrines of fair use, fair dealing, or other
|
|
150
|
+
equivalents.
|
|
151
|
+
|
|
152
|
+
2.7. Conditions
|
|
153
|
+
|
|
154
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
155
|
+
in Section 2.1.
|
|
156
|
+
|
|
157
|
+
3. Responsibilities
|
|
158
|
+
-------------------
|
|
159
|
+
|
|
160
|
+
3.1. Distribution of Source Form
|
|
161
|
+
|
|
162
|
+
All distribution of Covered Software in Source Code Form, including any
|
|
163
|
+
Modifications that You create or to which You contribute, must be under
|
|
164
|
+
the terms of this License. You must inform recipients that the Source
|
|
165
|
+
Code Form of the Covered Software is governed by the terms of this
|
|
166
|
+
License, and how they can obtain a copy of this License. You may not
|
|
167
|
+
attempt to alter or restrict the recipients' rights in the Source Code
|
|
168
|
+
Form.
|
|
169
|
+
|
|
170
|
+
3.2. Distribution of Executable Form
|
|
171
|
+
|
|
172
|
+
If You distribute Covered Software in Executable Form then:
|
|
173
|
+
|
|
174
|
+
(a) such Covered Software must also be made available in Source Code
|
|
175
|
+
Form, as described in Section 3.1, and You must inform recipients of
|
|
176
|
+
the Executable Form how they can obtain a copy of such Source Code
|
|
177
|
+
Form by reasonable means in a timely manner, at a charge no more
|
|
178
|
+
than the cost of distribution to the recipient; and
|
|
179
|
+
|
|
180
|
+
(b) You may distribute such Executable Form under the terms of this
|
|
181
|
+
License, or sublicense it under different terms, provided that the
|
|
182
|
+
license for the Executable Form does not attempt to limit or alter
|
|
183
|
+
the recipients' rights in the Source Code Form under this License.
|
|
184
|
+
|
|
185
|
+
3.3. Distribution of a Larger Work
|
|
186
|
+
|
|
187
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
|
188
|
+
provided that You also comply with the requirements of this License for
|
|
189
|
+
the Covered Software. If the Larger Work is a combination of Covered
|
|
190
|
+
Software with a work governed by one or more Secondary Licenses, and the
|
|
191
|
+
Covered Software is not Incompatible With Secondary Licenses, this
|
|
192
|
+
License permits You to additionally distribute such Covered Software
|
|
193
|
+
under the terms of such Secondary License(s), so that the recipient of
|
|
194
|
+
the Larger Work may, at their option, further distribute the Covered
|
|
195
|
+
Software under the terms of either this License or such Secondary
|
|
196
|
+
License(s).
|
|
197
|
+
|
|
198
|
+
3.4. Notices
|
|
199
|
+
|
|
200
|
+
You may not remove or alter the substance of any license notices
|
|
201
|
+
(including copyright notices, patent notices, disclaimers of warranty,
|
|
202
|
+
or limitations of liability) contained within the Source Code Form of
|
|
203
|
+
the Covered Software, except that You may alter any license notices to
|
|
204
|
+
the extent required to remedy known factual inaccuracies.
|
|
205
|
+
|
|
206
|
+
3.5. Application of Additional Terms
|
|
207
|
+
|
|
208
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
|
209
|
+
indemnity or liability obligations to one or more recipients of Covered
|
|
210
|
+
Software. However, You may do so only on Your own behalf, and not on
|
|
211
|
+
behalf of any Contributor. You must make it absolutely clear that any
|
|
212
|
+
such warranty, support, indemnity, or liability obligation is offered by
|
|
213
|
+
You alone, and You hereby agree to indemnify every Contributor for any
|
|
214
|
+
liability incurred by such Contributor as a result of warranty, support,
|
|
215
|
+
indemnity or liability terms You offer. You may include additional
|
|
216
|
+
disclaimers of warranty and limitations of liability specific to any
|
|
217
|
+
jurisdiction.
|
|
218
|
+
|
|
219
|
+
4. Inability to Comply Due to Statute or Regulation
|
|
220
|
+
---------------------------------------------------
|
|
221
|
+
|
|
222
|
+
If it is impossible for You to comply with any of the terms of this
|
|
223
|
+
License with respect to some or all of the Covered Software due to
|
|
224
|
+
statute, judicial order, or regulation then You must: (a) comply with
|
|
225
|
+
the terms of this License to the maximum extent possible; and (b)
|
|
226
|
+
describe the limitations and the code they affect. Such description must
|
|
227
|
+
be placed in a text file included with all distributions of the Covered
|
|
228
|
+
Software under this License. Except to the extent prohibited by statute
|
|
229
|
+
or regulation, such description must be sufficiently detailed for a
|
|
230
|
+
recipient of ordinary skill to be able to understand it.
|
|
231
|
+
|
|
232
|
+
5. Termination
|
|
233
|
+
--------------
|
|
234
|
+
|
|
235
|
+
5.1. The rights granted under this License will terminate automatically
|
|
236
|
+
if You fail to comply with any of its terms. However, if You become
|
|
237
|
+
compliant, then the rights granted under this License from a particular
|
|
238
|
+
Contributor are reinstated (a) provisionally, unless and until such
|
|
239
|
+
Contributor explicitly and finally terminates Your grants, and (b) on an
|
|
240
|
+
ongoing basis, if such Contributor fails to notify You of the
|
|
241
|
+
non-compliance by some reasonable means prior to 60 days after You have
|
|
242
|
+
come back into compliance. Moreover, Your grants from a particular
|
|
243
|
+
Contributor are reinstated on an ongoing basis if such Contributor
|
|
244
|
+
notifies You of the non-compliance by some reasonable means, this is the
|
|
245
|
+
first time You have received notice of non-compliance with this License
|
|
246
|
+
from such Contributor, and You become compliant prior to 30 days after
|
|
247
|
+
Your receipt of the notice.
|
|
248
|
+
|
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
|
250
|
+
infringement claim (excluding declaratory judgment actions,
|
|
251
|
+
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
252
|
+
directly or indirectly infringes any patent, then the rights granted to
|
|
253
|
+
You by any and all Contributors for the Covered Software under Section
|
|
254
|
+
2.1 of this License shall terminate.
|
|
255
|
+
|
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
|
257
|
+
end user license agreements (excluding distributors and resellers) which
|
|
258
|
+
have been validly granted by You or Your distributors under this License
|
|
259
|
+
prior to termination shall survive termination.
|
|
260
|
+
|
|
261
|
+
************************************************************************
|
|
262
|
+
* *
|
|
263
|
+
* 6. Disclaimer of Warranty *
|
|
264
|
+
* ------------------------- *
|
|
265
|
+
* *
|
|
266
|
+
* Covered Software is provided under this License on an "as is" *
|
|
267
|
+
* basis, without warranty of any kind, either expressed, implied, or *
|
|
268
|
+
* statutory, including, without limitation, warranties that the *
|
|
269
|
+
* Covered Software is free of defects, merchantable, fit for a *
|
|
270
|
+
* particular purpose or non-infringing. The entire risk as to the *
|
|
271
|
+
* quality and performance of the Covered Software is with You. *
|
|
272
|
+
* Should any Covered Software prove defective in any respect, You *
|
|
273
|
+
* (not any Contributor) assume the cost of any necessary servicing, *
|
|
274
|
+
* repair, or correction. This disclaimer of warranty constitutes an *
|
|
275
|
+
* essential part of this License. No use of any Covered Software is *
|
|
276
|
+
* authorized under this License except under this disclaimer. *
|
|
277
|
+
* *
|
|
278
|
+
************************************************************************
|
|
279
|
+
|
|
280
|
+
************************************************************************
|
|
281
|
+
* *
|
|
282
|
+
* 7. Limitation of Liability *
|
|
283
|
+
* -------------------------- *
|
|
284
|
+
* *
|
|
285
|
+
* Under no circumstances and under no legal theory, whether tort *
|
|
286
|
+
* (including negligence), contract, or otherwise, shall any *
|
|
287
|
+
* Contributor, or anyone who distributes Covered Software as *
|
|
288
|
+
* permitted above, be liable to You for any direct, indirect, *
|
|
289
|
+
* special, incidental, or consequential damages of any character *
|
|
290
|
+
* including, without limitation, damages for lost profits, loss of *
|
|
291
|
+
* goodwill, work stoppage, computer failure or malfunction, or any *
|
|
292
|
+
* and all other commercial damages or losses, even if such party *
|
|
293
|
+
* shall have been informed of the possibility of such damages. This *
|
|
294
|
+
* limitation of liability shall not apply to liability for death or *
|
|
295
|
+
* personal injury resulting from such party's negligence to the *
|
|
296
|
+
* extent applicable law prohibits such limitation. Some *
|
|
297
|
+
* jurisdictions do not allow the exclusion or limitation of *
|
|
298
|
+
* incidental or consequential damages, so this exclusion and *
|
|
299
|
+
* limitation may not apply to You. *
|
|
300
|
+
* *
|
|
301
|
+
************************************************************************
|
|
302
|
+
|
|
303
|
+
8. Litigation
|
|
304
|
+
-------------
|
|
305
|
+
|
|
306
|
+
Any litigation relating to this License may be brought only in the
|
|
307
|
+
courts of a jurisdiction where the defendant maintains its principal
|
|
308
|
+
place of business and such litigation shall be governed by laws of that
|
|
309
|
+
jurisdiction, without reference to its conflict-of-law provisions.
|
|
310
|
+
Nothing in this Section shall prevent a party's ability to bring
|
|
311
|
+
cross-claims or counter-claims.
|
|
312
|
+
|
|
313
|
+
9. Miscellaneous
|
|
314
|
+
----------------
|
|
315
|
+
|
|
316
|
+
This License represents the complete agreement concerning the subject
|
|
317
|
+
matter hereof. If any provision of this License is held to be
|
|
318
|
+
unenforceable, such provision shall be reformed only to the extent
|
|
319
|
+
necessary to make it enforceable. Any law or regulation which provides
|
|
320
|
+
that the language of a contract shall be construed against the drafter
|
|
321
|
+
shall not be used to construe this License against a Contributor.
|
|
322
|
+
|
|
323
|
+
10. Versions of the License
|
|
324
|
+
---------------------------
|
|
325
|
+
|
|
326
|
+
10.1. New Versions
|
|
327
|
+
|
|
328
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
|
329
|
+
10.3, no one other than the license steward has the right to modify or
|
|
330
|
+
publish new versions of this License. Each version will be given a
|
|
331
|
+
distinguishing version number.
|
|
332
|
+
|
|
333
|
+
10.2. Effect of New Versions
|
|
334
|
+
|
|
335
|
+
You may distribute the Covered Software under the terms of the version
|
|
336
|
+
of the License under which You originally received the Covered Software,
|
|
337
|
+
or under the terms of any subsequent version published by the license
|
|
338
|
+
steward.
|
|
339
|
+
|
|
340
|
+
10.3. Modified Versions
|
|
341
|
+
|
|
342
|
+
If you create software not governed by this License, and you want to
|
|
343
|
+
create a new license for such software, you may create and use a
|
|
344
|
+
modified version of this License if you rename the license and remove
|
|
345
|
+
any references to the name of the license steward (except to note that
|
|
346
|
+
such modified license differs from this License).
|
|
347
|
+
|
|
348
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
349
|
+
Licenses
|
|
350
|
+
|
|
351
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
|
352
|
+
Secondary Licenses under the terms of this version of the License, the
|
|
353
|
+
notice described in Exhibit B of this License must be attached.
|
|
354
|
+
|
|
355
|
+
Exhibit A - Source Code Form License Notice
|
|
356
|
+
-------------------------------------------
|
|
357
|
+
|
|
358
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
|
359
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
360
|
+
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
361
|
+
|
|
362
|
+
If it is not possible or desirable to put the notice in a particular
|
|
363
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
364
|
+
file in a relevant directory) where a recipient would be likely to look
|
|
365
|
+
for such a notice.
|
|
366
|
+
|
|
367
|
+
You may add additional accurate notices of copyright ownership.
|
|
368
|
+
|
|
369
|
+
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
370
|
+
---------------------------------------------------------
|
|
371
|
+
|
|
372
|
+
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
373
|
+
defined by the Mozilla Public License, v. 2.0.
|
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: aipython-shell
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: IPython that understands what you meant: non-Python cells are turned into Python by an LLM and run.
|
|
5
|
+
Author: Claus Dahl
|
|
6
|
+
License-Expression: MPL-2.0
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Keywords: ai,claude,data science,ipython,llm,natural language,ollama,openai,repl
|
|
9
|
+
Classifier: Development Status :: 3 - Alpha
|
|
10
|
+
Classifier: Environment :: Console
|
|
11
|
+
Classifier: Framework :: IPython
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Intended Audience :: Science/Research
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
16
|
+
Classifier: Topic :: Scientific/Engineering
|
|
17
|
+
Classifier: Topic :: Software Development :: Interpreters
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Requires-Dist: ipython>=8.0
|
|
20
|
+
Requires-Dist: litellm>=1.109
|
|
21
|
+
Requires-Dist: pyflakes>=3.0
|
|
22
|
+
Requires-Dist: tomli>=2.0; python_version < '3.11'
|
|
23
|
+
Provides-Extra: test
|
|
24
|
+
Requires-Dist: pandas; extra == 'test'
|
|
25
|
+
Requires-Dist: pytest; extra == 'test'
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
|
|
28
|
+
# aipython
|
|
29
|
+
|
|
30
|
+
**IPython that understands what you meant.**
|
|
31
|
+
|
|
32
|
+
[](https://github.com/clausd/aipython/actions/workflows/ci.yml)
|
|
33
|
+
[](https://pypi.org/project/aipython-shell/)
|
|
34
|
+
[](LICENSE)
|
|
35
|
+
|
|
36
|
+
`aipython` is a plain IPython shell with one difference: when a cell isn't valid Python, an LLM
|
|
37
|
+
turns it into Python and runs it. Type code when you know the code, type what you want when you
|
|
38
|
+
don't, and mix the two freely. Real Python never touches the model and runs with no delay.
|
|
39
|
+
|
|
40
|
+
## A real session
|
|
41
|
+
|
|
42
|
+
An excerpt from an actual session: the lines after `In [n]:` are what was typed, the dimmed
|
|
43
|
+
`✨` lines are the code the model wrote, streamed in as it was generated and then run.
|
|
44
|
+
Outputs are left out.
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
In [1]: Find the most recent csv in ~/Downloads and load it as a pandas df
|
|
48
|
+
✨ import glob, os
|
|
49
|
+
import pandas as pd
|
|
50
|
+
|
|
51
|
+
latest_csv = max(glob.glob(os.path.expanduser("~/Downloads/*.csv")), key=os.path.getmtime)
|
|
52
|
+
df = pd.read_csv(latest_csv)
|
|
53
|
+
print(latest_csv)
|
|
54
|
+
df.head()
|
|
55
|
+
|
|
56
|
+
In [2]: list the column names
|
|
57
|
+
✨ df.columns.tolist()
|
|
58
|
+
|
|
59
|
+
In [6]: df.date.min()
|
|
60
|
+
|
|
61
|
+
In [8]: convert the date column to actual dates
|
|
62
|
+
✨ df['date'] = pd.to_datetime(df['date'], errors='coerce')
|
|
63
|
+
df['date'].dtype
|
|
64
|
+
|
|
65
|
+
In [9]: df.date.min()
|
|
66
|
+
|
|
67
|
+
In [13]: list all unique dates
|
|
68
|
+
✨ sorted(df['date'].dt.date.unique())
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Cells 6 and 9 are ordinary Python, so they ran directly without a model call.
|
|
72
|
+
|
|
73
|
+
## Install
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
pipx install aipython-shell # or: uv tool install aipython-shell / pip install aipython-shell
|
|
77
|
+
export ANTHROPIC_API_KEY=... # the default model is Claude Haiku
|
|
78
|
+
aipython
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Or load it into any IPython session with `%load_ext aipython`.
|
|
82
|
+
|
|
83
|
+
If you work with pandas and friends, install aipython into the same environment as them
|
|
84
|
+
(`pip install aipython-shell`) so the generated code can import them. A `pipx` install lives in its own
|
|
85
|
+
environment.
|
|
86
|
+
|
|
87
|
+
## How it works
|
|
88
|
+
|
|
89
|
+
Every cell goes through the same steps:
|
|
90
|
+
|
|
91
|
+
1. **IPython first.** IPython's own transforms run as usual, so `%magics`, `!shell` commands and
|
|
92
|
+
`obj?` help all behave normally.
|
|
93
|
+
2. **Is it Python?** The cell is parsed and checked with pyflakes against your live variables.
|
|
94
|
+
If it parses and every name it uses exists, it runs untouched. This check is local and instant.
|
|
95
|
+
3. **If not, ask the model.** Syntax errors, unknown names (`describe`, `prnt(x)`), and English
|
|
96
|
+
that IPython would mistake for a magic or help request (`reset the index of df`,
|
|
97
|
+
`what is x?`) go to the model. The model writes Python, which streams to your terminal and runs.
|
|
98
|
+
|
|
99
|
+
The model gets enough context to write code that fits your session:
|
|
100
|
+
|
|
101
|
+
- a summary of your variables: types, shapes, DataFrame columns and dtypes, imported modules,
|
|
102
|
+
function signatures
|
|
103
|
+
- your last few cells, the code generated for them, and any errors, so "fix that" and
|
|
104
|
+
"try again" work
|
|
105
|
+
- tools to look closer when the summary isn't enough: `inspect_variable` (dtypes, null counts,
|
|
106
|
+
first rows), `column_values` (exact category spellings) and `search_namespace`
|
|
107
|
+
|
|
108
|
+
`In[n]` holds the code that actually ran. Up-arrow brings back what you typed.
|
|
109
|
+
|
|
110
|
+
## Token use
|
|
111
|
+
|
|
112
|
+
Each translation ends with one dim line showing what it cost:
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
In [2]: list the column names
|
|
116
|
+
✨ df.columns.tolist()
|
|
117
|
+
↳ 1,204 in · 14 out · $0.0001 · 0.8s
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
`%ai` shows the running total for the session, and it is printed when you exit:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
aipython: 12 translations · 15,880 in / 702 out tokens · $0.0019
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
Costs come from litellm's price list. They are left out for models without a known price, and
|
|
127
|
+
for free local models; token counts are always shown.
|
|
128
|
+
|
|
129
|
+
## Session logs
|
|
130
|
+
|
|
131
|
+
Off by default. Turn on with `%ai log on`, or `log = true` in the config file, and the session
|
|
132
|
+
is written as a Python file: every cell in order, with what you typed as a comment above the
|
|
133
|
+
code the model wrote for it.
|
|
134
|
+
|
|
135
|
+
```python
|
|
136
|
+
# [1] Find the most recent csv in ~/Downloads and load it as a pandas df
|
|
137
|
+
# ✨ anthropic/claude-haiku-5-5 · 1,204 in · 61 out · $0.0002 · 1.1s
|
|
138
|
+
import glob, os
|
|
139
|
+
import pandas as pd
|
|
140
|
+
...
|
|
141
|
+
|
|
142
|
+
# [6]
|
|
143
|
+
df.date.min()
|
|
144
|
+
|
|
145
|
+
# [11]
|
|
146
|
+
df.date.uniq()
|
|
147
|
+
# ! AttributeError: 'Series' object has no attribute 'uniq'
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
It reads as the Python your session became, and `ipython <file>` replays it. Logs go to
|
|
151
|
+
`~/.local/share/aipython/sessions/` (or `$XDG_DATA_HOME/aipython/sessions/`, or `log_dir` in the
|
|
152
|
+
config), one file per session, named by start time. `%ai log` shows the current file.
|
|
153
|
+
|
|
154
|
+
To see everything the model was given and did (the variable summary, recent cells, tool calls
|
|
155
|
+
and their results, token counts), turn on the debug log with `%ai debug on` or `debug = true`.
|
|
156
|
+
It writes one JSON line per translation to a `.jsonl` file next to the session log. The two
|
|
157
|
+
logs are independent.
|
|
158
|
+
|
|
159
|
+
Even with both off, IPython's own history keeps both versions of every cell: `%history` lists
|
|
160
|
+
the code that ran, `%history -r` what you typed.
|
|
161
|
+
|
|
162
|
+
## What is sent to the model
|
|
163
|
+
|
|
164
|
+
Only cells that aren't Python are sent. With each one goes the variable summary above,
|
|
165
|
+
including short previews of small values (up to 80 characters each), plus your recent cells.
|
|
166
|
+
More is sent only if the model asks for it through a tool: the first 5 rows of a DataFrame,
|
|
167
|
+
the first 10 values of a Series, the most common values of one column, or a longer preview
|
|
168
|
+
(up to 1500 characters) of another object. If that is too much for your data, use a
|
|
169
|
+
local model (see below) or `%ai off`.
|
|
170
|
+
|
|
171
|
+
## Commands
|
|
172
|
+
|
|
173
|
+
```
|
|
174
|
+
%ai status and tokens used this session
|
|
175
|
+
%ai on | off turn automatic translation on or off
|
|
176
|
+
%ai model <name> haiku (default), sonnet, opus, or any litellm model
|
|
177
|
+
%ai config settings, config file location, which key is in use
|
|
178
|
+
%ai context the variable summary the model sees
|
|
179
|
+
%ai last the last generated code
|
|
180
|
+
%ai log [on | off] write this session as a .py file (off by default); show where
|
|
181
|
+
%ai debug on | off also log the full exchange with the model (.jsonl)
|
|
182
|
+
%ai <anything> send this to the model even if it looks like Python
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
## Models
|
|
186
|
+
|
|
187
|
+
Models are reached through [litellm](https://docs.litellm.ai/docs/providers), so any provider it
|
|
188
|
+
supports works. Choose one with `%ai model <name>` or the `AIPYTHON_MODEL` environment variable,
|
|
189
|
+
and set that provider's usual API key:
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
AIPYTHON_MODEL=anthropic/claude-sonnet-5-5 # ANTHROPIC_API_KEY
|
|
193
|
+
AIPYTHON_MODEL=openai/gpt-5.4 # OPENAI_API_KEY
|
|
194
|
+
AIPYTHON_MODEL=ollama_chat/qwen2.5-coder # local Ollama, no key
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
For any OpenAI-compatible server (LM Studio, vLLM, llama.cpp), use `openai/<model>` and set
|
|
198
|
+
`AIPYTHON_API_BASE`, e.g. `http://localhost:1234/v1`.
|
|
199
|
+
|
|
200
|
+
Models without tool calling still work, with only the variable summary to go on. Small local
|
|
201
|
+
models are noticeably worse at this than hosted ones.
|
|
202
|
+
|
|
203
|
+
## Configuration
|
|
204
|
+
|
|
205
|
+
Without a config file, aipython uses your environment: the provider's usual API key variable and
|
|
206
|
+
the default model. To keep settings and keys in one place, create
|
|
207
|
+
`~/.config/aipython/config.toml`:
|
|
208
|
+
|
|
209
|
+
```toml
|
|
210
|
+
model = "anthropic/claude-sonnet-5-5"
|
|
211
|
+
# api_base = "http://localhost:1234/v1"
|
|
212
|
+
# log = true # write each session as a .py file (default false)
|
|
213
|
+
# debug = true # also log the full exchange with the model (default false)
|
|
214
|
+
# log_dir = "~/notes/aipython"
|
|
215
|
+
|
|
216
|
+
[keys] # one per provider, used when that provider's model is selected
|
|
217
|
+
anthropic = "sk-ant-..."
|
|
218
|
+
openai = "sk-..."
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
- Keys are passed directly to the model call and never put into the environment, so code you
|
|
222
|
+
run in the session can't read them.
|
|
223
|
+
- A provider without a key in the file falls back to its environment variable.
|
|
224
|
+
- `AIPYTHON_MODEL` and `AIPYTHON_API_BASE` override the file; `AIPYTHON_CONFIG` points to a
|
|
225
|
+
different file, and `$XDG_CONFIG_HOME` is respected.
|
|
226
|
+
- aipython warns at startup if the file is readable by other users (`chmod 600` it).
|
|
227
|
+
|
|
228
|
+
## Limitations
|
|
229
|
+
|
|
230
|
+
- **Valid Python is trusted as Python.** `df.date.uniq()` parses and `df` exists, so it runs and
|
|
231
|
+
fails with an `AttributeError` instead of being fixed. Typing `fix that` afterwards works,
|
|
232
|
+
because the error is passed to the model.
|
|
233
|
+
- **Generated code runs without asking.** It streams to the screen as it runs, so you see what
|
|
234
|
+
happened, but there is no confirmation step. Use `%ai off` when that matters.
|
|
235
|
+
- A line of English ending in `:` makes IPython wait for more input, as it would for a `for`
|
|
236
|
+
loop. Press Enter again.
|
|
237
|
+
|
|
238
|
+
## Development
|
|
239
|
+
|
|
240
|
+
```bash
|
|
241
|
+
uv run --extra test pytest
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
Releases go to PyPI through GitHub Actions with
|
|
245
|
+
[Trusted Publishing](https://docs.pypi.org/trusted-publishers/). To release, bump `__version__`
|
|
246
|
+
in `aipython/__init__.py`, push, and run `gh release create vX.Y.Z --generate-notes`.
|
|
247
|
+
|
|
248
|
+
The PyPI project is `aipython-shell` (`aipython` is taken by its similarity to `ai-python`); the
|
|
249
|
+
package, the command and `%load_ext` are all `aipython`.
|
|
250
|
+
|
|
251
|
+
One-time setup on PyPI: add a pending publisher for project `aipython-shell`, owner `clausd`,
|
|
252
|
+
repository `aipython`, workflow `publish.yml`, environment `pypi`.
|
|
253
|
+
|
|
254
|
+
## License
|
|
255
|
+
|
|
256
|
+
[Mozilla Public License 2.0](LICENSE).
|