docstring-to-text 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.
@@ -0,0 +1,142 @@
1
+ # Compiled from various templates - for python, Unity projects and CG/VFX content in general.
2
+ # Organized+extended by Lex-DRL: https://github.com/Lex-DRL/git-template-gamedev
3
+
4
+ # WARNING: Despite character classes ([xX] patterns) officially being supported by git,
5
+ # SourceTree is a single GUI known to have issues with them. If you use SourceTree,
6
+ # you need to "flatten" rules into hard-spelled ones for each case (both `*.txt` and `*.TXT`).
7
+
8
+ # Auto-detect text/binary by default + force UNIX line endings on clone/pull for all text files:
9
+ * text=auto eol=lf
10
+
11
+ # raw-Text files
12
+ *.[Cc][Ss][Vv] text
13
+ *.[Mm][Dd] text diff=markdown
14
+ *.[Tt][Xx][Tt] text
15
+
16
+ # Checksums
17
+ *.[Mm][Dd]5 text
18
+ *.[Ss][Hh][Aa] text
19
+ *.[Ss][Hh][Aa][0123456789]* text
20
+
21
+ # Scripts: OS
22
+ # `eol=crlf` only affects working copy. Commits are still with LF
23
+ *.[Bb][Aa][Tt] text eol=crlf
24
+ *.[Cc][Mm][Dd] text eol=crlf
25
+ *.[Pp][Ll] text
26
+ *.[Pp][Ss]1 text eol=crlf
27
+ *.[Ss][Hh] text diff=bash
28
+
29
+ # Scripts: Python
30
+ *.[Pp][Yy] text diff=python
31
+
32
+ # Scripts: Other programming languages
33
+ *.[Cc][Ss] text diff=csharp
34
+ *.[Cc][Ss][Ss] text diff=css
35
+ *.[Hh] text diff=cpp
36
+ *.[Hh][Tt][Mm] text diff=html
37
+ *.[Hh][Tt][Mm][Ll] text diff=html
38
+ *.[Jj][Ss] text
39
+ *.[Jj][Ss][Oo][Nn] text
40
+ *.[Pp][Hh][Pp] text diff=php
41
+ *.[Ss][Qq][Ll] text=auto eol=lf
42
+ *.[Xx][Mm][Ll] text diff=html
43
+ *.[Xx][Hh][Tt][Mm][Ll] text diff=html
44
+ *.[Yy][Aa][Mm][Ll] text
45
+ *.[Yy][Mm][Ll] text
46
+
47
+ # Visual Studio
48
+ *.[Cc][Ss][Pp][Rr][Oo][Jj] text eol=crlf diff=html
49
+
50
+ # Vector graphics
51
+ *.[Ss][Vv][Gg] text
52
+
53
+
54
+ # =========================================================================== #
55
+ # Common binary formats
56
+ # =========================================================================== #
57
+
58
+ # For LFS: replace "binary" to "filter=lfs diff=lfs merge=lfs -text"
59
+
60
+ *.[Dd][Bb] binary
61
+ *.[Mm][Dd][Bb] binary
62
+ *.[Pp][Dd][Tt] binary
63
+
64
+ # Android/Java
65
+ *.[AaJj][Aa][Rr] binary
66
+ *.[Aa][Pp][Kk] binary
67
+
68
+ # Archives
69
+ *.7[Zz] binary
70
+ *.7[Zz].* binary
71
+ *.[Gg][Zz] binary
72
+ *.[Gg][Zz].* binary
73
+ *.[Zz][Ii][Pp] binary
74
+ *.[RrTt][Aa][Rr] binary
75
+
76
+ # Python binaries:
77
+ *.[Pp][Yy][CcDdOo] binary
78
+ *.[Pp][Dd][Bb] binary
79
+ *.[Ww][Hh][Ll] binary
80
+
81
+ # OS libraries / Executables / Software dev
82
+ *.[Aa] binary
83
+ *.[Bb][Yy][Tt][Ee][Ss] binary
84
+ *.[Dd][Ll][Ll] binary
85
+ *.[Ee][Xx][Ee] binary
86
+ *.[Ll][Ii][Bb] binary
87
+ *.[NnXx][Ii][Bb] binary
88
+ *.[Ss][Oo] binary
89
+ *.[Ss][Yy][Ss] binary
90
+
91
+ # Fonts
92
+ *.[Ee][Oo][Tt] binary
93
+ *.[OoTt][Tt][Ff] binary
94
+ *.[Ww][Oo][Ff][Ff] binary
95
+ *.[Ww][Oo][Ff][Ff]2 binary
96
+
97
+ # Images: HDR
98
+ *.[Ee][Xx][Rr] binary
99
+ *.[Hh][Dd][Rr] binary
100
+ *.[Tt][Ii][Ff] binary
101
+ *.[Tt][Ii][Ff][Ff] binary
102
+
103
+ # Images: Primary
104
+ *.[Bb][Mm][Pp] binary
105
+ *.[Gg][Ii][Ff] binary
106
+ *.[Jj][Pp][Gg] binary
107
+ *.[Jj][Pp][Ee][Gg] binary
108
+ *.[Pp][Nn][Gg] binary
109
+ *.[Tt][Gg][Aa] binary
110
+ *.[Ww][Ee][Bb][Pp] binary
111
+
112
+ # Images: Other
113
+ *.[Cc][Uu][Rr] binary
114
+ *.[Ii][Cc][Nn][Ss] binary
115
+ *.[Ii][Cc][OoNn] binary
116
+ *.[Ii][Cc][Oo][Nn] binary
117
+ *.[Pp][Dd][Ff] binary
118
+ *.[Pp][Ss][DdBb] binary
119
+
120
+ # Audio
121
+ *.[Aa][Aa][Cc] binary
122
+ *.[AaFf][Ll][Aa][Cc] binary
123
+ *.[Aa][Ii][Ff] binary
124
+ *.[Cc][Aa][Ff] binary
125
+ *.[Mm]4[Aa] binary
126
+ *.[Mm][Pp][1234] binary
127
+ *.[Oo][Gg][GgAa] binary
128
+ *.[Ww][Aa][Vv] binary
129
+
130
+ # Video
131
+ # mp4 caught by audio pattern
132
+ *.[Aa][Vv][Ii] binary
133
+ *.[Bb][Ii][Kk] binary
134
+ *.[Mm][4KkOo][Vv] binary
135
+ *.[Oo][Gg][VvXx] binary
136
+ *.[Ss][Ww][Ff] binary
137
+
138
+
139
+ # =========================================================================== #
140
+ # Repo-specific
141
+ # =========================================================================== #
142
+ # add here
@@ -0,0 +1,157 @@
1
+ # Organized+extended by Lex-DRL: https://github.com/Lex-DRL/git-template-gamedev
2
+
3
+ # Common
4
+ # ----------------------------
5
+
6
+ # Temp files/folders:
7
+ *.tmp
8
+ *.temp
9
+ tmp*/
10
+ temp*/
11
+
12
+ # Programming - general
13
+ *.log
14
+
15
+ # OS-generated - Windows
16
+ # ----------------------------
17
+
18
+ [Tt]humbs.db
19
+ [Dd]esktop.ini
20
+
21
+ # OS-generated - Apple
22
+ # ----------------------------
23
+
24
+ .DS_Store*
25
+ .AppleDouble
26
+ .LSOverride
27
+
28
+ # ... and thumbnails
29
+ ._*
30
+
31
+ # Files that might appear in the root of a volume
32
+ .DocumentRevisions-V100
33
+ .fseventsd
34
+ .Spotlight-V100
35
+ .TemporaryItems
36
+ .Trashes
37
+ .VolumeIcon.icns
38
+ .com.apple.timemachine.donotpresent
39
+
40
+ # Directories potentially created on remote AFP share
41
+ .AppleDB
42
+ .AppleDesktop
43
+ Network Trash Folder
44
+ Temporary Items
45
+ .apdisk
46
+
47
+
48
+ # =========================================================================== #
49
+ # IDEs
50
+ # =========================================================================== #
51
+
52
+ # JetBrains IDEs: PyCharm / Rider
53
+ .idea/
54
+ *.iml
55
+ *.ipr
56
+ *.iws
57
+
58
+ # vscode
59
+ .vscode/
60
+ .claude/
61
+ .history/
62
+ *.code-workspace
63
+
64
+
65
+ # =========================================================================== #
66
+ # Python-related
67
+ # =========================================================================== #
68
+ # src: https://github.com/github/gitignore/blob/main/Python.gitignore
69
+
70
+ # Environments
71
+ .env*
72
+ .venv*
73
+ env*/
74
+ venv*/
75
+
76
+ # Byte-compiled / optimized / DLL files
77
+ __pycache__/
78
+ *.py[cod]
79
+ *$py.class
80
+
81
+ # C extensions
82
+ *.so
83
+
84
+ # Distribution / packaging
85
+ .Python
86
+ build/
87
+ develop-eggs/
88
+ dist/
89
+ downloads/
90
+ eggs/
91
+ .eggs/
92
+ lib/
93
+ lib64/
94
+ parts/
95
+ sdist/
96
+ var/
97
+ wheels/
98
+ share/python-wheels/
99
+ *.egg-info/
100
+ .installed.cfg
101
+ *.egg
102
+
103
+ # PyInstaller
104
+ # Usually these files are written by a python script from a template
105
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
106
+ MANIFEST
107
+ *.manifest
108
+ *.spec
109
+
110
+ # Installer logs
111
+ pip-log.txt
112
+ pip-delete-this-directory.txt
113
+
114
+ # Unit test / coverage reports
115
+ htmlcov/
116
+ .tox/
117
+ .nox/
118
+ .coverage
119
+ .coverage.*
120
+ .cache
121
+ nosetests.xml
122
+ coverage.xml
123
+ *.cover
124
+ *,cover
125
+ .hypothesis/
126
+ .pytest_cache/
127
+ cover/
128
+
129
+ # Translations
130
+ *.mo
131
+ *.pot
132
+
133
+ # Scrapy stuff:
134
+ .scrapy
135
+
136
+ # Sphinx documentation
137
+ docs/_build/
138
+
139
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
140
+ __pypackages__/
141
+
142
+ # mkdocs documentation
143
+ /site
144
+
145
+ # mypy
146
+ .mypy_cache/
147
+ .dmypy.json
148
+ dmypy.json
149
+
150
+ # pytype static type analyzer
151
+ .pytype/
152
+
153
+
154
+ # =========================================================================== #
155
+ # Repo-specific
156
+ # =========================================================================== #
157
+ # add here
@@ -0,0 +1,370 @@
1
+ # Mozilla Public License Version 2.0
2
+
3
+ ## 1. Definitions
4
+
5
+ ### 1.1. “Contributor”
6
+
7
+ means each individual or legal entity that creates, contributes to
8
+ the creation of, or owns Covered Software.
9
+
10
+ ### 1.2. “Contributor Version”
11
+
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
+
17
+ means Covered Software of a particular Contributor.
18
+
19
+ ### 1.4. “Covered Software”
20
+
21
+ means Source Code Form to which the initial Contributor has attached
22
+ the notice in Exhibit A, the Executable Form of such Source Code
23
+ Form, and Modifications of such Source Code Form, in each case
24
+ including portions thereof.
25
+
26
+ ### 1.5. “Incompatible With Secondary Licenses”
27
+
28
+ means
29
+
30
+ * **(a)** that the initial Contributor has attached the notice described
31
+ in Exhibit B to the Covered Software; or
32
+ * **(b)** that the Covered Software was made available under the terms of
33
+ version 1.1 or earlier of the License, but not also under the
34
+ terms of a Secondary License.
35
+
36
+ ### 1.6. “Executable Form”
37
+
38
+ means any form of the work other than Source Code Form.
39
+
40
+ ### 1.7. “Larger Work”
41
+
42
+ means a work that combines Covered Software with other material, in
43
+ a separate file or files, that is not Covered Software.
44
+
45
+ ### 1.8. “License”
46
+
47
+ means this document.
48
+
49
+ ### 1.9. “Licensable”
50
+
51
+ means having the right to grant, to the maximum extent possible,
52
+ whether at the time of the initial grant or subsequently, any and
53
+ all of the rights conveyed by this License.
54
+
55
+ ### 1.10. “Modifications”
56
+
57
+ means any of the following:
58
+
59
+ * **(a)** any file in Source Code Form that results from an addition to,
60
+ deletion from, or modification of the contents of Covered
61
+ Software; or
62
+ * **(b)** any new file in Source Code Form that contains any Covered
63
+ Software.
64
+
65
+ ### 1.11. “Patent Claims” of a Contributor
66
+
67
+ means any patent claim(s), including without limitation, method,
68
+ process, and apparatus claims, in any patent Licensable by such
69
+ Contributor that would be infringed, but for the grant of the
70
+ License, by the making, using, selling, offering for sale, having
71
+ made, import, or transfer of either its Contributions or its
72
+ Contributor Version.
73
+
74
+ ### 1.12. “Secondary License”
75
+
76
+ means either the GNU General Public License, Version 2.0, the GNU
77
+ Lesser General Public License, Version 2.1, the GNU Affero General
78
+ Public License, Version 3.0, or any later versions of those
79
+ licenses.
80
+
81
+ ### 1.13. “Source Code Form”
82
+
83
+ means the form of the work preferred for making modifications.
84
+
85
+ ### 1.14. “You” (or “Your”)
86
+
87
+ means an individual or a legal entity exercising rights under this
88
+ License. For legal entities, “You” includes any entity that
89
+ controls, is controlled by, or is under common control with You. For
90
+ purposes of this definition, “control” means **(a)** the power, direct
91
+ or indirect, to cause the direction or management of such entity,
92
+ whether by contract or otherwise, or **(b)** ownership of more than
93
+ fifty percent (50%) of the outstanding shares or beneficial
94
+ ownership of such entity.
95
+
96
+
97
+ ## 2. License Grants and Conditions
98
+
99
+ ### 2.1. Grants
100
+
101
+ Each Contributor hereby grants You a world-wide, royalty-free,
102
+ non-exclusive license:
103
+
104
+ * **(a)** under intellectual property rights (other than patent or trademark)
105
+ Licensable by such Contributor to use, reproduce, make available,
106
+ modify, display, perform, distribute, and otherwise exploit its
107
+ Contributions, either on an unmodified basis, with Modifications, or
108
+ as part of a Larger Work; and
109
+ * **(b)** under Patent Claims of such Contributor to make, use, sell, offer
110
+ for sale, have made, import, and otherwise transfer either its
111
+ Contributions or its Contributor Version.
112
+
113
+ ### 2.2. Effective Date
114
+
115
+ The licenses granted in Section 2.1 with respect to any Contribution
116
+ become effective for each Contribution on the date the Contributor first
117
+ distributes such Contribution.
118
+
119
+ ### 2.3. Limitations on Grant Scope
120
+
121
+ The licenses granted in this Section 2 are the only rights granted under
122
+ this License. No additional rights or licenses will be implied from the
123
+ distribution or licensing of Covered Software under this License.
124
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
125
+ Contributor:
126
+
127
+ * **(a)** for any code that a Contributor has removed from Covered Software;
128
+ or
129
+ * **(b)** for infringements caused by: **(i)** Your and any other third party's
130
+ modifications of Covered Software, or **(ii)** the combination of its
131
+ Contributions with other software (except as part of its Contributor
132
+ Version); or
133
+ * **(c)** under Patent Claims infringed by Covered Software in the absence of
134
+ its Contributions.
135
+
136
+ This License does not grant any rights in the trademarks, service marks,
137
+ or logos of any Contributor (except as may be necessary to comply with
138
+ the notice requirements in Section 3.4).
139
+
140
+ ### 2.4. Subsequent Licenses
141
+
142
+ No Contributor makes additional grants as a result of Your choice to
143
+ distribute the Covered Software under a subsequent version of this
144
+ License (see Section 10.2) or under the terms of a Secondary License (if
145
+ permitted under the terms of Section 3.3).
146
+
147
+ ### 2.5. Representation
148
+
149
+ Each Contributor represents that the Contributor believes its
150
+ Contributions are its original creation(s) or it has sufficient rights
151
+ to grant the rights to its Contributions conveyed by this License.
152
+
153
+ ### 2.6. Fair Use
154
+
155
+ This License is not intended to limit any rights You have under
156
+ applicable copyright doctrines of fair use, fair dealing, or other
157
+ equivalents.
158
+
159
+ ### 2.7. Conditions
160
+
161
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
162
+ in Section 2.1.
163
+
164
+
165
+ ## 3. Responsibilities
166
+
167
+ ### 3.1. Distribution of Source Form
168
+
169
+ All distribution of Covered Software in Source Code Form, including any
170
+ Modifications that You create or to which You contribute, must be under
171
+ the terms of this License. You must inform recipients that the Source
172
+ Code Form of the Covered Software is governed by the terms of this
173
+ License, and how they can obtain a copy of this License. You may not
174
+ attempt to alter or restrict the recipients' rights in the Source Code
175
+ Form.
176
+
177
+ ### 3.2. Distribution of Executable Form
178
+
179
+ If You distribute Covered Software in Executable Form then:
180
+
181
+ * **(a)** such Covered Software must also be made available in Source Code
182
+ Form, as described in Section 3.1, and You must inform recipients of
183
+ the Executable Form how they can obtain a copy of such Source Code
184
+ Form by reasonable means in a timely manner, at a charge no more
185
+ than the cost of distribution to the recipient; and
186
+
187
+ * **(b)** You may distribute such Executable Form under the terms of this
188
+ License, or sublicense it under different terms, provided that the
189
+ license for the Executable Form does not attempt to limit or alter
190
+ the recipients' rights in the Source Code Form under this License.
191
+
192
+ ### 3.3. Distribution of a Larger Work
193
+
194
+ You may create and distribute a Larger Work under terms of Your choice,
195
+ provided that You also comply with the requirements of this License for
196
+ the Covered Software. If the Larger Work is a combination of Covered
197
+ Software with a work governed by one or more Secondary Licenses, and the
198
+ Covered Software is not Incompatible With Secondary Licenses, this
199
+ License permits You to additionally distribute such Covered Software
200
+ under the terms of such Secondary License(s), so that the recipient of
201
+ the Larger Work may, at their option, further distribute the Covered
202
+ Software under the terms of either this License or such Secondary
203
+ License(s).
204
+
205
+ ### 3.4. Notices
206
+
207
+ You may not remove or alter the substance of any license notices
208
+ (including copyright notices, patent notices, disclaimers of warranty,
209
+ or limitations of liability) contained within the Source Code Form of
210
+ the Covered Software, except that You may alter any license notices to
211
+ the extent required to remedy known factual inaccuracies.
212
+
213
+ ### 3.5. Application of Additional Terms
214
+
215
+ You may choose to offer, and to charge a fee for, warranty, support,
216
+ indemnity or liability obligations to one or more recipients of Covered
217
+ Software. However, You may do so only on Your own behalf, and not on
218
+ behalf of any Contributor. You must make it absolutely clear that any
219
+ such warranty, support, indemnity, or liability obligation is offered by
220
+ You alone, and You hereby agree to indemnify every Contributor for any
221
+ liability incurred by such Contributor as a result of warranty, support,
222
+ indemnity or liability terms You offer. You may include additional
223
+ disclaimers of warranty and limitations of liability specific to any
224
+ jurisdiction.
225
+
226
+
227
+ ## 4. Inability to Comply Due to Statute or Regulation
228
+
229
+ If it is impossible for You to comply with any of the terms of this
230
+ License with respect to some or all of the Covered Software due to
231
+ statute, judicial order, or regulation then You must: **(a)** comply with
232
+ the terms of this License to the maximum extent possible; and **(b)**
233
+ describe the limitations and the code they affect. Such description must
234
+ be placed in a text file included with all distributions of the Covered
235
+ Software under this License. Except to the extent prohibited by statute
236
+ or regulation, such description must be sufficiently detailed for a
237
+ recipient of ordinary skill to be able to understand it.
238
+
239
+
240
+ ## 5. Termination
241
+
242
+ **5.1.** The rights granted under this License will terminate automatically
243
+ if You fail to comply with any of its terms. However, if You become
244
+ compliant, then the rights granted under this License from a particular
245
+ Contributor are reinstated **(a)** provisionally, unless and until such
246
+ Contributor explicitly and finally terminates Your grants, and **(b)** on an
247
+ ongoing basis, if such Contributor fails to notify You of the
248
+ non-compliance by some reasonable means prior to 60 days after You have
249
+ come back into compliance. Moreover, Your grants from a particular
250
+ Contributor are reinstated on an ongoing basis if such Contributor
251
+ notifies You of the non-compliance by some reasonable means, this is the
252
+ first time You have received notice of non-compliance with this License
253
+ from such Contributor, and You become compliant prior to 30 days after
254
+ Your receipt of the notice.
255
+
256
+ **5.2.** If You initiate litigation against any entity by asserting a patent
257
+ infringement claim (excluding declaratory judgment actions,
258
+ counter-claims, and cross-claims) alleging that a Contributor Version
259
+ directly or indirectly infringes any patent, then the rights granted to
260
+ You by any and all Contributors for the Covered Software under Section
261
+ 2.1 of this License shall terminate.
262
+
263
+ **5.3.** In the event of termination under Sections 5.1 or 5.2 above, all
264
+ end user license agreements (excluding distributors and resellers) which
265
+ have been validly granted by You or Your distributors under this License
266
+ prior to termination shall survive termination.
267
+
268
+
269
+ ## 6. Disclaimer of Warranty
270
+
271
+ > [!WARNING]
272
+ > Covered Software is provided under this License on an “as is”
273
+ > basis, without warranty of any kind, either expressed, implied, or
274
+ > statutory, including, without limitation, warranties that the
275
+ > Covered Software is free of defects, merchantable, fit for a
276
+ > particular purpose or non-infringing. The entire risk as to the
277
+ > quality and performance of the Covered Software is with You.
278
+ > Should any Covered Software prove defective in any respect, You
279
+ > (not any Contributor) assume the cost of any necessary servicing,
280
+ > repair, or correction. This disclaimer of warranty constitutes an
281
+ > essential part of this License. No use of any Covered Software is
282
+ > authorized under this License except under this disclaimer.
283
+
284
+ ## 7. Limitation of Liability
285
+
286
+ > [!WARNING]
287
+ > Under no circumstances and under no legal theory, whether tort
288
+ > (including negligence), contract, or otherwise, shall any
289
+ > Contributor, or anyone who distributes Covered Software as
290
+ > permitted above, be liable to You for any direct, indirect,
291
+ > special, incidental, or consequential damages of any character
292
+ > including, without limitation, damages for lost profits, loss of
293
+ > goodwill, work stoppage, computer failure or malfunction, or any
294
+ > and all other commercial damages or losses, even if such party
295
+ > shall have been informed of the possibility of such damages. This
296
+ > limitation of liability shall not apply to liability for death or
297
+ > personal injury resulting from such party's negligence to the
298
+ > extent applicable law prohibits such limitation. Some
299
+ > jurisdictions do not allow the exclusion or limitation of
300
+ > incidental or consequential damages, so this exclusion and
301
+ > limitation may not apply to You.
302
+
303
+
304
+ ## 8. Litigation
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
+
314
+ ## 9. Miscellaneous
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
+
324
+ ## 10. Versions of the License
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 Licenses
349
+
350
+ If You choose to distribute Source Code Form that is Incompatible With
351
+ Secondary Licenses under the terms of this version of the License, the
352
+ notice described in Exhibit B of this License must be attached.
353
+
354
+ ## Exhibit A - Source Code Form License Notice
355
+
356
+ > This Source Code Form is subject to the terms of the Mozilla Public
357
+ > License, v. 2.0. If a copy of the MPL was not distributed with this
358
+ > file, You can obtain one at http://mozilla.org/MPL/2.0/.
359
+
360
+ If it is not possible or desirable to put the notice in a particular
361
+ file, then You may include the notice in a location (such as a LICENSE
362
+ file in a relevant directory) where a recipient would be likely to look
363
+ for such a notice.
364
+
365
+ You may add additional accurate notices of copyright ownership.
366
+
367
+ ## Exhibit B - “Incompatible With Secondary Licenses” Notice
368
+
369
+ > This Source Code Form is "Incompatible With Secondary Licenses", as
370
+ > defined by the Mozilla Public License, v. 2.0.
@@ -0,0 +1,18 @@
1
+ Metadata-Version: 2.4
2
+ Name: docstring-to-text
3
+ Version: 0.0.1
4
+ Summary: A simple pip package converting docstrings into clean text (proper paragraphs and indents)
5
+ Project-URL: Homepage, https://github.com/Lex-DRL/Py-docstring-to-text
6
+ Project-URL: Issues, https://github.com/Lex-DRL/Py-docstring-to-text/issues
7
+ Author: Lex Darlog (Lex-DRL)
8
+ License-Expression: MPL-2.0
9
+ License-File: LICENSE.md
10
+ Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Programming Language :: Python :: 3
13
+ Requires-Python: >=3.7
14
+ Description-Content-Type: text/markdown
15
+
16
+ # docstring-to-text
17
+
18
+ A simple pip package converting docstrings into clean text (proper paragraphs and indents)
@@ -0,0 +1,3 @@
1
+ # docstring-to-text
2
+
3
+ A simple pip package converting docstrings into clean text (proper paragraphs and indents)
@@ -0,0 +1,23 @@
1
+ @echo off
2
+
3
+ call .\venv\Scripts\activate.bat
4
+
5
+ echo Where python:
6
+ echo.
7
+ where python
8
+ echo.
9
+ echo Continue?
10
+
11
+ pause
12
+
13
+ .\venv\Scripts\python.exe -m pip install -U pip
14
+ .\venv\Scripts\python.exe -m pip install -U build
15
+
16
+ echo.
17
+ echo.
18
+ echo ============================================================
19
+ echo.
20
+ echo.
21
+
22
+ .\venv\Scripts\python.exe -m build
23
+ pause
@@ -0,0 +1,30 @@
1
+ [build-system]
2
+ requires = ["hatchling >= 1.26"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "docstring-to-text"
7
+ dynamic = ["version"]
8
+ # version = "0.0.1"
9
+ description = "A simple pip package converting docstrings into clean text (proper paragraphs and indents)"
10
+ authors = [
11
+ { name="Lex Darlog (Lex-DRL)" },
12
+ ]
13
+ readme = "README.md"
14
+ # https://packaging.python.org/en/latest/specifications/core-metadata/#license-expression
15
+ # https://spdx.org/licenses/
16
+ license = "MPL-2.0"
17
+ license-files = ["LICEN[CS]E*"]
18
+ requires-python = ">=3.7"
19
+ classifiers = [
20
+ "Programming Language :: Python :: 3",
21
+ "Operating System :: OS Independent",
22
+ "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
23
+ ]
24
+
25
+ [project.urls]
26
+ Homepage = "https://github.com/Lex-DRL/Py-docstring-to-text"
27
+ Issues = "https://github.com/Lex-DRL/Py-docstring-to-text/issues"
28
+
29
+ [tool.hatch.version]
30
+ path = "src/docstring_to_text/__package_meta.py"
@@ -0,0 +1,6 @@
1
+ # encoding: utf-8
2
+ """
3
+ """
4
+
5
+ from .__package_meta import VERSION
6
+ from .__package_meta import VERSION as __version__
@@ -0,0 +1,3 @@
1
+ # encoding: utf-8
2
+
3
+ VERSION = "0.0.1"