dialoghelper 0.0.1__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.

Potentially problematic release.


This version of dialoghelper might be problematic. Click here for more details.

@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,5 @@
1
+ include settings.ini
2
+ include LICENSE
3
+ include CONTRIBUTING.md
4
+ include README.md
5
+ recursive-exclude * __pycache__
@@ -0,0 +1,106 @@
1
+ Metadata-Version: 2.4
2
+ Name: dialoghelper
3
+ Version: 0.0.1
4
+ Summary: Helper functions for solveit dialogs
5
+ Home-page: https://github.com/AnswerDotAI/dialoghelper
6
+ Author: Jeremy Howard
7
+ Author-email: github@jhoward.fastmail.fm
8
+ License: Apache Software License 2.0
9
+ Keywords: nbdev jupyter notebook python
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Natural Language :: English
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: License :: OSI Approved :: Apache Software License
18
+ Requires-Python: >=3.9
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: fastcore
22
+ Requires-Dist: fastlite
23
+ Requires-Dist: ghapi
24
+ Requires-Dist: ipykernel-helper
25
+ Provides-Extra: dev
26
+ Dynamic: author
27
+ Dynamic: author-email
28
+ Dynamic: classifier
29
+ Dynamic: description
30
+ Dynamic: description-content-type
31
+ Dynamic: home-page
32
+ Dynamic: keywords
33
+ Dynamic: license
34
+ Dynamic: license-file
35
+ Dynamic: provides-extra
36
+ Dynamic: requires-dist
37
+ Dynamic: requires-python
38
+ Dynamic: summary
39
+
40
+ # dialoghelper
41
+
42
+
43
+ <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
44
+
45
+ This file will become your README and also the index of your
46
+ documentation.
47
+
48
+ ## Developer Guide
49
+
50
+ If you are new to using `nbdev` here are some useful pointers to get you
51
+ started.
52
+
53
+ ### Install dialoghelper in Development mode
54
+
55
+ ``` sh
56
+ # make sure dialoghelper package is installed in development mode
57
+ $ pip install -e .
58
+
59
+ # make changes under nbs/ directory
60
+ # ...
61
+
62
+ # compile to have changes apply to dialoghelper
63
+ $ nbdev_prepare
64
+ ```
65
+
66
+ ## Usage
67
+
68
+ ### Installation
69
+
70
+ Install latest from the GitHub
71
+ [repository](https://github.com/AnswerDotAI/dialoghelper):
72
+
73
+ ``` sh
74
+ $ pip install git+https://github.com/AnswerDotAI/dialoghelper.git
75
+ ```
76
+
77
+ or from [conda](https://anaconda.org/AnswerDotAI/dialoghelper)
78
+
79
+ ``` sh
80
+ $ conda install -c AnswerDotAI dialoghelper
81
+ ```
82
+
83
+ or from [pypi](https://pypi.org/project/dialoghelper/)
84
+
85
+ ``` sh
86
+ $ pip install dialoghelper
87
+ ```
88
+
89
+ ### Documentation
90
+
91
+ Documentation can be found hosted on this GitHub
92
+ [repository](https://github.com/AnswerDotAI/dialoghelper)’s
93
+ [pages](https://AnswerDotAI.github.io/dialoghelper/). Additionally you
94
+ can find package manager specific guidelines on
95
+ [conda](https://anaconda.org/AnswerDotAI/dialoghelper) and
96
+ [pypi](https://pypi.org/project/dialoghelper/) respectively.
97
+
98
+ ## How to use
99
+
100
+ Fill me in please! Don’t forget code examples:
101
+
102
+ ``` python
103
+ 1+1
104
+ ```
105
+
106
+ 2
@@ -0,0 +1,67 @@
1
+ # dialoghelper
2
+
3
+
4
+ <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
5
+
6
+ This file will become your README and also the index of your
7
+ documentation.
8
+
9
+ ## Developer Guide
10
+
11
+ If you are new to using `nbdev` here are some useful pointers to get you
12
+ started.
13
+
14
+ ### Install dialoghelper in Development mode
15
+
16
+ ``` sh
17
+ # make sure dialoghelper package is installed in development mode
18
+ $ pip install -e .
19
+
20
+ # make changes under nbs/ directory
21
+ # ...
22
+
23
+ # compile to have changes apply to dialoghelper
24
+ $ nbdev_prepare
25
+ ```
26
+
27
+ ## Usage
28
+
29
+ ### Installation
30
+
31
+ Install latest from the GitHub
32
+ [repository](https://github.com/AnswerDotAI/dialoghelper):
33
+
34
+ ``` sh
35
+ $ pip install git+https://github.com/AnswerDotAI/dialoghelper.git
36
+ ```
37
+
38
+ or from [conda](https://anaconda.org/AnswerDotAI/dialoghelper)
39
+
40
+ ``` sh
41
+ $ conda install -c AnswerDotAI dialoghelper
42
+ ```
43
+
44
+ or from [pypi](https://pypi.org/project/dialoghelper/)
45
+
46
+ ``` sh
47
+ $ pip install dialoghelper
48
+ ```
49
+
50
+ ### Documentation
51
+
52
+ Documentation can be found hosted on this GitHub
53
+ [repository](https://github.com/AnswerDotAI/dialoghelper)’s
54
+ [pages](https://AnswerDotAI.github.io/dialoghelper/). Additionally you
55
+ can find package manager specific guidelines on
56
+ [conda](https://anaconda.org/AnswerDotAI/dialoghelper) and
57
+ [pypi](https://pypi.org/project/dialoghelper/) respectively.
58
+
59
+ ## How to use
60
+
61
+ Fill me in please! Don’t forget code examples:
62
+
63
+ ``` python
64
+ 1+1
65
+ ```
66
+
67
+ 2
@@ -0,0 +1,2 @@
1
+ __version__ = "0.0.1"
2
+ from .core import *
@@ -0,0 +1,21 @@
1
+ # Autogenerated by nbdev
2
+
3
+ d = { 'settings': { 'branch': 'main',
4
+ 'doc_baseurl': '/dialoghelper',
5
+ 'doc_host': 'https://AnswerDotAI.github.io',
6
+ 'git_url': 'https://github.com/AnswerDotAI/dialoghelper',
7
+ 'lib_path': 'dialoghelper'},
8
+ 'syms': { 'dialoghelper.core': { 'dialoghelper.core.add_msg': ('core.html#add_msg', 'dialoghelper/core.py'),
9
+ 'dialoghelper.core.find_dialog_id': ('core.html#find_dialog_id', 'dialoghelper/core.py'),
10
+ 'dialoghelper.core.find_msg_id': ('core.html#find_msg_id', 'dialoghelper/core.py'),
11
+ 'dialoghelper.core.find_msgs': ('core.html#find_msgs', 'dialoghelper/core.py'),
12
+ 'dialoghelper.core.find_var': ('core.html#find_var', 'dialoghelper/core.py'),
13
+ 'dialoghelper.core.get_db': ('core.html#get_db', 'dialoghelper/core.py'),
14
+ 'dialoghelper.core.gist_file': ('core.html#gist_file', 'dialoghelper/core.py'),
15
+ 'dialoghelper.core.import_gist': ('core.html#import_gist', 'dialoghelper/core.py'),
16
+ 'dialoghelper.core.import_string': ('core.html#import_string', 'dialoghelper/core.py'),
17
+ 'dialoghelper.core.load_gist': ('core.html#load_gist', 'dialoghelper/core.py'),
18
+ 'dialoghelper.core.msg_idx': ('core.html#msg_idx', 'dialoghelper/core.py'),
19
+ 'dialoghelper.core.read_msg': ('core.html#read_msg', 'dialoghelper/core.py'),
20
+ 'dialoghelper.core.read_msg_ids': ('core.html#read_msg_ids', 'dialoghelper/core.py'),
21
+ 'dialoghelper.core.update_msg': ('core.html#update_msg', 'dialoghelper/core.py')}}}
@@ -0,0 +1,127 @@
1
+ # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/00_core.ipynb.
2
+
3
+ # %% auto 0
4
+ __all__ = ['get_db', 'find_var', 'find_dialog_id', 'find_msgs', 'find_msg_id', 'read_msg_ids', 'msg_idx', 'read_msg', 'add_msg',
5
+ 'update_msg', 'load_gist', 'gist_file', 'import_string', 'import_gist']
6
+
7
+ # %% ../nbs/00_core.ipynb
8
+ import inspect, json, importlib, linecache
9
+ from tempfile import TemporaryDirectory
10
+ from ipykernel_helper import *
11
+
12
+ from fastcore.utils import *
13
+ from ghapi.all import *
14
+ from fastlite import *
15
+
16
+ # %% ../nbs/00_core.ipynb
17
+ def get_db():
18
+ if os.environ.get('IN_SOLVEIT', False): dataparent,nm = Path('/app'),'data.db'
19
+ else: dataparent,nm = Path('..'),'dev_data.db'
20
+ db = database(dataparent/'data'/nm)
21
+ all_dcs(db)
22
+ return db
23
+
24
+ # %% ../nbs/00_core.ipynb
25
+ def find_var(var: str):
26
+ "Search for var in all frames of the call stack"
27
+ frame = inspect.currentframe()
28
+ while frame:
29
+ dv = frame.f_globals.get(var, frame.f_locals.get(var, None))
30
+ if dv: return dv
31
+ frame = frame.f_back
32
+ raise ValueError(f"Could not find {var} in any scope")
33
+
34
+ # %% ../nbs/00_core.ipynb
35
+ def find_dialog_id():
36
+ "Get the dialog id by searching the call stack for __dialog_id."
37
+ return find_var('__dialog_id')
38
+
39
+ # %% ../nbs/00_core.ipynb
40
+ def find_msgs(pattern: str, limit=10):
41
+ "Find messages in a specific dialog that contain the given pattern."
42
+ did = find_dialog_id()
43
+ return db.t.message('did=? AND content LIKE ?', [did, f'%{pattern}%'], limit=limit)
44
+
45
+ # %% ../nbs/00_core.ipynb
46
+ def find_msg_id():
47
+ "Get the message id by searching the call stack for __dialog_id."
48
+ return find_var('__msg_id')
49
+
50
+ # %% ../nbs/00_core.ipynb
51
+ def read_msg_ids():
52
+ "Get all ids in current dialog."
53
+ did = find_dialog_id()
54
+ return [o.sid for o in db.t.message('did=?', [did], select='sid', order_by='id')]
55
+
56
+ # %% ../nbs/00_core.ipynb
57
+ def msg_idx():
58
+ "Get index of current message in dialog."
59
+ ids = read_msg_ids()
60
+ return ids,ids.index(find_msg_id())
61
+
62
+ # %% ../nbs/00_core.ipynb
63
+ def read_msg(n: int=-1, # Message index (if relative, +ve is downwards)
64
+ relative=True # Is `n` relative to current message (True) or absolute (False)?
65
+ ):
66
+ "Get the message indexed in the current dialog."
67
+ ids,idx = msg_idx()
68
+ if relative:
69
+ idx = idx+n
70
+ if not 0<=idx<len(ids): return None
71
+ else: idx = n
72
+ return db.t.message.fetchone('sid=?', [ids[idx]])
73
+
74
+ # %% ../nbs/00_core.ipynb
75
+ def add_msg(
76
+ content:str, # message that we are updating or adding before/after
77
+ msg_type: str='note', # message type, can be 'code', 'note', or 'prompt'
78
+ output='', # for prompts/code, initial output
79
+ placement='add_after', # can be 'add_after', 'add_before', 'update', 'at_start', 'at_end'
80
+ msg_id=None
81
+ ):
82
+ "Add/update a message to the queue to show after code execution completes."
83
+ assert msg_type in ('note', 'code', 'prompt'), "msg_type must be 'code', 'note', or 'prompt'."
84
+ kwargs = dict(content=content, msg_type=msg_type, output=output, placement=placement)
85
+ if msg_id: kwargs['msg_id']=msg_id
86
+ run_cmd('add_msg', **kwargs)
87
+
88
+ # %% ../nbs/00_core.ipynb
89
+ def update_msg(msg):
90
+ "Update an existing message in the dialog."
91
+ add_msg(content=msg.content, msg_type=msg.msg_type, output=msg.output, placement='update', msg_id=msg.id)
92
+
93
+ # %% ../nbs/00_core.ipynb
94
+ def load_gist(gist_id):
95
+ "Get the first file from a gist"
96
+ api = GhApi()
97
+ if '/' in gist_id: *_,user,gist_id = gist_id.split('/')
98
+ else: user = None
99
+ return api.gists.get(gist_id, user=user)
100
+
101
+ # %% ../nbs/00_core.ipynb
102
+ def gist_file(gist_id):
103
+ "Get the first file from a gist"
104
+ gist = load_gist(gist_id)
105
+ return first(gist.files.values())
106
+
107
+ # %% ../nbs/00_core.ipynb
108
+ def import_string(code, name):
109
+ with TemporaryDirectory() as tmpdir:
110
+ path = Path(tmpdir) / f"{name}.py"
111
+ path.write_text(code)
112
+ # linecache.cache storage allows inspect.getsource() after tmpdir lifetime ends
113
+ linecache.cache[str(path)] = (len(code), None, code.splitlines(keepends=True), str(path))
114
+ spec = importlib.util.spec_from_file_location(name, path)
115
+ module = importlib.util.module_from_spec(spec)
116
+ sys.modules[name] = module
117
+ spec.loader.exec_module(module)
118
+ return module
119
+
120
+ # %% ../nbs/00_core.ipynb
121
+ def import_gist(gist_id, mod_name=None, add_global=True):
122
+ "Import gist directly from string without saving to disk"
123
+ fil = gist_file(gist_id)
124
+ mod_name = mod_name or Path(fil['filename']).stem
125
+ module = import_string(fil['content'], mod_name)
126
+ if add_global: inspect.currentframe().f_back.f_globals[mod_name] = module
127
+ return module
@@ -0,0 +1,106 @@
1
+ Metadata-Version: 2.4
2
+ Name: dialoghelper
3
+ Version: 0.0.1
4
+ Summary: Helper functions for solveit dialogs
5
+ Home-page: https://github.com/AnswerDotAI/dialoghelper
6
+ Author: Jeremy Howard
7
+ Author-email: github@jhoward.fastmail.fm
8
+ License: Apache Software License 2.0
9
+ Keywords: nbdev jupyter notebook python
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Natural Language :: English
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: License :: OSI Approved :: Apache Software License
18
+ Requires-Python: >=3.9
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: fastcore
22
+ Requires-Dist: fastlite
23
+ Requires-Dist: ghapi
24
+ Requires-Dist: ipykernel-helper
25
+ Provides-Extra: dev
26
+ Dynamic: author
27
+ Dynamic: author-email
28
+ Dynamic: classifier
29
+ Dynamic: description
30
+ Dynamic: description-content-type
31
+ Dynamic: home-page
32
+ Dynamic: keywords
33
+ Dynamic: license
34
+ Dynamic: license-file
35
+ Dynamic: provides-extra
36
+ Dynamic: requires-dist
37
+ Dynamic: requires-python
38
+ Dynamic: summary
39
+
40
+ # dialoghelper
41
+
42
+
43
+ <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
44
+
45
+ This file will become your README and also the index of your
46
+ documentation.
47
+
48
+ ## Developer Guide
49
+
50
+ If you are new to using `nbdev` here are some useful pointers to get you
51
+ started.
52
+
53
+ ### Install dialoghelper in Development mode
54
+
55
+ ``` sh
56
+ # make sure dialoghelper package is installed in development mode
57
+ $ pip install -e .
58
+
59
+ # make changes under nbs/ directory
60
+ # ...
61
+
62
+ # compile to have changes apply to dialoghelper
63
+ $ nbdev_prepare
64
+ ```
65
+
66
+ ## Usage
67
+
68
+ ### Installation
69
+
70
+ Install latest from the GitHub
71
+ [repository](https://github.com/AnswerDotAI/dialoghelper):
72
+
73
+ ``` sh
74
+ $ pip install git+https://github.com/AnswerDotAI/dialoghelper.git
75
+ ```
76
+
77
+ or from [conda](https://anaconda.org/AnswerDotAI/dialoghelper)
78
+
79
+ ``` sh
80
+ $ conda install -c AnswerDotAI dialoghelper
81
+ ```
82
+
83
+ or from [pypi](https://pypi.org/project/dialoghelper/)
84
+
85
+ ``` sh
86
+ $ pip install dialoghelper
87
+ ```
88
+
89
+ ### Documentation
90
+
91
+ Documentation can be found hosted on this GitHub
92
+ [repository](https://github.com/AnswerDotAI/dialoghelper)’s
93
+ [pages](https://AnswerDotAI.github.io/dialoghelper/). Additionally you
94
+ can find package manager specific guidelines on
95
+ [conda](https://anaconda.org/AnswerDotAI/dialoghelper) and
96
+ [pypi](https://pypi.org/project/dialoghelper/) respectively.
97
+
98
+ ## How to use
99
+
100
+ Fill me in please! Don’t forget code examples:
101
+
102
+ ``` python
103
+ 1+1
104
+ ```
105
+
106
+ 2
@@ -0,0 +1,16 @@
1
+ LICENSE
2
+ MANIFEST.in
3
+ README.md
4
+ pyproject.toml
5
+ settings.ini
6
+ setup.py
7
+ dialoghelper/__init__.py
8
+ dialoghelper/_modidx.py
9
+ dialoghelper/core.py
10
+ dialoghelper.egg-info/PKG-INFO
11
+ dialoghelper.egg-info/SOURCES.txt
12
+ dialoghelper.egg-info/dependency_links.txt
13
+ dialoghelper.egg-info/entry_points.txt
14
+ dialoghelper.egg-info/not-zip-safe
15
+ dialoghelper.egg-info/requires.txt
16
+ dialoghelper.egg-info/top_level.txt
@@ -0,0 +1,2 @@
1
+ [nbdev]
2
+ dialoghelper = dialoghelper._modidx:d
@@ -0,0 +1,6 @@
1
+ fastcore
2
+ fastlite
3
+ ghapi
4
+ ipykernel-helper
5
+
6
+ [dev]
@@ -0,0 +1 @@
1
+ dialoghelper
@@ -0,0 +1,11 @@
1
+ [build-system]
2
+ requires = ["setuptools>=64.0"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name="dialoghelper"
7
+ requires-python=">=3.9"
8
+ dynamic = [ "keywords", "description", "version", "dependencies", "optional-dependencies", "readme", "license", "authors", "classifiers", "entry-points", "scripts", "urls"]
9
+
10
+ [tool.uv]
11
+ cache-keys = [{ file = "pyproject.toml" }, { file = "settings.ini" }, { file = "setup.py" }]
@@ -0,0 +1,47 @@
1
+ [DEFAULT]
2
+ # All sections below are required unless otherwise specified.
3
+ # See https://github.com/AnswerDotAI/nbdev/blob/main/settings.ini for examples.
4
+
5
+ ### Python library ###
6
+ repo = dialoghelper
7
+ lib_name = %(repo)s
8
+ version = 0.0.1
9
+ min_python = 3.9
10
+ license = apache2
11
+ black_formatting = False
12
+ requirements = fastcore fastlite ghapi ipykernel-helper
13
+
14
+ ### nbdev ###
15
+ doc_path = _docs
16
+ lib_path = dialoghelper
17
+ nbs_path = nbs
18
+ recursive = True
19
+ tst_flags = notest
20
+ put_version_in_init = True
21
+ update_pyproject = True
22
+ cell_number = False
23
+
24
+ ### Docs ###
25
+ branch = main
26
+ custom_sidebar = False
27
+ doc_host = https://%(user)s.github.io
28
+ doc_baseurl = /%(repo)s
29
+ git_url = https://github.com/%(user)s/%(repo)s
30
+ title = %(lib_name)s
31
+
32
+ ### PyPI ###
33
+ audience = Developers
34
+ author = Jeremy Howard
35
+ author_email = github@jhoward.fastmail.fm
36
+ copyright = 2025 onwards, %(author)s
37
+ description = Helper functions for solveit dialogs
38
+ keywords = nbdev jupyter notebook python
39
+ language = English
40
+ status = 3
41
+ user = AnswerDotAI
42
+
43
+ ### Optional ###
44
+ # dev_requirements =
45
+ # console_scripts =
46
+ # conda_user =
47
+ # package_data =
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,64 @@
1
+ from pkg_resources import parse_version
2
+ from configparser import ConfigParser
3
+ import setuptools, shlex
4
+ assert parse_version(setuptools.__version__)>=parse_version('36.2')
5
+
6
+ # note: all settings are in settings.ini; edit there, not here
7
+ config = ConfigParser(delimiters=['='])
8
+ config.read('settings.ini', encoding='utf-8')
9
+ cfg = config['DEFAULT']
10
+
11
+ cfg_keys = 'version description keywords author author_email'.split()
12
+ expected = cfg_keys + "lib_name user branch license status min_python audience language".split()
13
+ for o in expected: assert o in cfg, "missing expected setting: {}".format(o)
14
+ setup_cfg = {o:cfg[o] for o in cfg_keys}
15
+
16
+ licenses = {
17
+ 'apache2': ('Apache Software License 2.0','OSI Approved :: Apache Software License'),
18
+ 'mit': ('MIT License', 'OSI Approved :: MIT License'),
19
+ 'gpl2': ('GNU General Public License v2', 'OSI Approved :: GNU General Public License v2 (GPLv2)'),
20
+ 'gpl3': ('GNU General Public License v3', 'OSI Approved :: GNU General Public License v3 (GPLv3)'),
21
+ 'bsd3': ('BSD License', 'OSI Approved :: BSD License'),
22
+ }
23
+ statuses = [ '1 - Planning', '2 - Pre-Alpha', '3 - Alpha',
24
+ '4 - Beta', '5 - Production/Stable', '6 - Mature', '7 - Inactive' ]
25
+ py_versions = '3.6 3.7 3.8 3.9 3.10 3.11 3.12'.split()
26
+
27
+ requirements = shlex.split(cfg.get('requirements', ''))
28
+ if cfg.get('pip_requirements'): requirements += shlex.split(cfg.get('pip_requirements', ''))
29
+ min_python = cfg['min_python']
30
+ lic = licenses.get(cfg['license'].lower(), (cfg['license'], None))
31
+ dev_requirements = (cfg.get('dev_requirements') or '').split()
32
+
33
+ package_data = dict()
34
+ pkg_data = cfg.get('package_data', None)
35
+ if pkg_data:
36
+ package_data[cfg['lib_name']] = pkg_data.split() # split as multiple files might be listed
37
+ # Add package data to setup_cfg for setuptools.setup(..., **setup_cfg)
38
+ setup_cfg['package_data'] = package_data
39
+
40
+ setuptools.setup(
41
+ name = cfg['lib_name'],
42
+ license = lic[0],
43
+ classifiers = [
44
+ 'Development Status :: ' + statuses[int(cfg['status'])],
45
+ 'Intended Audience :: ' + cfg['audience'].title(),
46
+ 'Natural Language :: ' + cfg['language'].title(),
47
+ ] + ['Programming Language :: Python :: '+o for o in py_versions[py_versions.index(min_python):]] + (['License :: ' + lic[1] ] if lic[1] else []),
48
+ url = cfg['git_url'],
49
+ packages = setuptools.find_packages(),
50
+ include_package_data = True,
51
+ install_requires = requirements,
52
+ extras_require={ 'dev': dev_requirements },
53
+ dependency_links = cfg.get('dep_links','').split(),
54
+ python_requires = '>=' + cfg['min_python'],
55
+ long_description = open('README.md', encoding='utf-8').read(),
56
+ long_description_content_type = 'text/markdown',
57
+ zip_safe = False,
58
+ entry_points = {
59
+ 'console_scripts': cfg.get('console_scripts','').split(),
60
+ 'nbdev': [f'{cfg.get("lib_path")}={cfg.get("lib_path")}._modidx:d']
61
+ },
62
+ **setup_cfg)
63
+
64
+