summaryrefslogtreecommitdiff
path: root/dev-python/typer/files/typer-avoid-python-dephell-dependency.patch
blob: ad072603a504dcb70e32dab996bae969414b0a88 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
diff -Nur a/README.rst b/README.rst
--- a/README.rst	1970-01-01 01:00:00.000000000 +0100
+++ b/README.rst	2020-06-14 13:03:51.180092891 +0100
@@ -0,0 +1,320 @@
+.. role:: raw-html-m2r(raw)
+   :format: html
+
+
+
+.. raw:: html
+
+   <p align="center">
+     <a href="https://typer.tiangolo.com"><img src="https://typer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" alt="Typer"></a>
+   </p>
+   <p align="center">
+       <em>Typer, build great CLIs. Easy to code. Based on Python type hints.</em>
+   </p>
+   <p align="center">
+   <a href="https://travis-ci.com/tiangolo/typer" target="_blank">
+       <img src="https://travis-ci.com/tiangolo/typer.svg?branch=master" alt="Build Status">
+   </a>
+   <a href="https://codecov.io/gh/tiangolo/typer" target="_blank">
+       <img src="https://img.shields.io/codecov/c/github/tiangolo/typer" alt="Coverage">
+   </a>
+   <a href="https://pypi.org/project/typer" target="_blank">
+       <img src="https://badge.fury.io/py/typer.svg" alt="Package version">
+   </a>
+   </p>
+
+
+----
+
+**Documentation**\ : :raw-html-m2r:`<a href="https://typer.tiangolo.com" target="_blank">https://typer.tiangolo.com</a>`
+
+**Source Code**\ : :raw-html-m2r:`<a href="https://github.com/tiangolo/typer" target="_blank">https://github.com/tiangolo/typer</a>`
+
+----
+
+Typer is library for building :raw-html-m2r:`<abbr title="command line interface, programs executed from a terminal">CLI</abbr>` applications that users will **love using** and developers will **love creating**. Based on Python 3.6+ type hints.
+
+The key features are:
+
+
+* **Intuitive to write**\ : Great editor support. :raw-html-m2r:`<abbr title="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr>` everywhere. Less time debugging. Designed to be easy to use and learn. Less time reading docs.
+* **Easy to use**\ : It's easy to use for the final users. Automatic help, and automatic completion for all shells.
+* **Short**\ : Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.
+* **Start simple**\ : The simplest example adds only 2 lines of code to your app: **1 import, 1 function call**.
+* **Grow large**\ : Grow in complexity as much as you want, create arbitrarily complex trees of commands and groups of subcommands, with options and arguments.
+
+FastAPI of CLIs
+---------------
+
+:raw-html-m2r:`<a href="https://fastapi.tiangolo.com" target="_blank"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" style="width: 20%;"></a>`
+
+**Typer** is :raw-html-m2r:`<a href="https://fastapi.tiangolo.com" class="external-link" target="_blank">FastAPI</a>`\ 's little sibling.
+
+And it's intended to be the FastAPI of CLIs.
+
+Requirements
+------------
+
+Python 3.6+
+
+**Typer** stands on the shoulders of a giant. Its only internal dependency is :raw-html-m2r:`<a href="https://click.palletsprojects.com/" class="external-link" target="_blank">Click</a>`.
+
+Installation
+------------
+
+
+.. raw:: html
+
+   <div class="termy">
+
+   ```console
+   $ pip install typer
+   ---> 100%
+   Successfully installed typer
+   ```
+
+   </div>
+
+
+Example
+-------
+
+The absolute minimum
+^^^^^^^^^^^^^^^^^^^^
+
+
+* Create a file ``main.py`` with:
+
+.. code-block:: Python
+
+   import typer
+
+
+   def main(name: str):
+       typer.echo(f"Hello {name}")
+
+
+   if __name__ == "__main__":
+       typer.run(main)
+
+Run it
+^^^^^^
+
+Run your application:
+
+
+.. raw:: html
+
+   <div class="termy">
+
+   ```console
+   // Run your application
+   $ python main.py
+
+   // You get a nice error, you are missing NAME
+   Usage: main.py [OPTIONS] NAME
+   Try "main.py --help" for help.
+
+   Error: Missing argument 'NAME'.
+
+   // You get a --help for free
+   $ python main.py --help
+
+   Usage: main.py [OPTIONS] NAME
+
+   Options:
+     --install-completion  Install completion for the current shell.
+     --show-completion     Show completion for the current shell, to copy it or customize the installation.
+     --help                Show this message and exit.
+
+   // When you create a package you get ✨ auto completion ✨ for free, installed with --install-completion
+
+   // Now pass the NAME argument
+   $ python main.py Camila
+
+   Hello Camila
+
+   // It works! 🎉
+   ```
+
+   </div>
+
+
+**Note**\ : Auto completion works when you create a Python package and run it with ``--install-completion`` or when you use :raw-html-m2r:`<a href="https://typer.tiangolo.com/typer-cli/" class="internal-link" target="_blank">Typer CLI</a>`.
+
+Example upgrade
+---------------
+
+This was the simplest example possible.
+
+Now let's see one a bit more complex.
+
+An example with two subcommands
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Modify the file ``main.py``.
+
+Create a ``typer.Typer()`` app, and create two subcommands with their parameters.
+
+```Python hl_lines="3  6  11  20"
+import typer
+
+app = typer.Typer()
+
+@app.command()
+def hello(name: str):
+    typer.echo(f"Hello {name}")
+
+@app.command()
+def goodbye(name: str, formal: bool = False):
+    if formal:
+        typer.echo(f"Goodbye Ms. {name}. Have a good day.")
+    else:
+        typer.echo(f"Bye {name}!")
+
+if **name** == "\ **main**\ ":
+    app()
+
+.. code-block::
+
+
+   And that will:
+
+   * Explicitly create a `typer.Typer` app.
+       * The previous `typer.run` actually creates one implicitly for you.
+   * Add two subcommands with `@app.command()`.
+   * Execute the `app()` itself, as if it was a function (instead of `typer.run`).
+
+   ### Run the upgraded example
+
+   <div class="termy">
+
+   ```console
+   // Check the --help
+   $ python main.py --help
+
+   Usage: main.py [OPTIONS] COMMAND [ARGS]...
+
+   Options:
+     --install-completion  Install completion for the current shell.
+     --show-completion     Show completion for the current shell, to copy it or customize the installation.
+     --help                Show this message and exit.
+
+   Commands:
+     goodbye
+     hello
+
+   // You have 2 subcommands (the 2 functions): goodbye and hello
+
+   // Now get the --help for hello
+
+   $ python main.py hello --help
+
+   Usage: main.py hello [OPTIONS] NAME
+
+   Options:
+     --help  Show this message and exit.
+
+   // And now get the --help for goodbye
+
+   $ python main.py goodbye --help
+
+   Usage: main.py goodbye [OPTIONS] NAME
+
+   Options:
+     --formal / --no-formal
+     --help                  Show this message and exit.
+
+   // Automatic --formal and --no-formal for the bool option 🎉
+
+   // And if you use it with the hello command
+
+   $ python main.py hello Camila
+
+   Hello Camila
+
+   // And with the goodbye command
+
+   $ python main.py goodbye Camila
+
+   Bye Camila!
+
+   // And with --formal
+
+   $ python main.py goodbye --formal Camila
+
+   Goodbye Ms. Camila. Have a good day.
+
+</div>
+
+Recap
+^^^^^
+
+In summary, you declare **once** the types of parameters (\ *CLI arguments* and *CLI options*\ ) as function parameters.
+
+You do that with standard modern Python types.
+
+You don't have to learn a new syntax, the methods or classes of a specific library, etc.
+
+Just standard **Python 3.6+**.
+
+For example, for an ``int``\ :
+
+.. code-block:: Python
+
+   total: int
+
+or for a ``bool`` flag:
+
+.. code-block:: Python
+
+   force: bool
+
+And similarly for **files**\ , **paths**\ , **enums** (choices), etc. And there are tools to create **groups of subcommands**\ , add metadata, extra **validation**\ , etc.
+
+**You get**\ : great editor support, including **completion** and **type checks** everywhere.
+
+**Your users get**\ : automatic **\ ``--help``\ **\ , **auto completion** in their terminal (Bash, Zsh, Fish, PowerShell) when they install your package or when using :raw-html-m2r:`<a href="https://typer.tiangolo.com/typer-cli/" class="internal-link" target="_blank">Typer CLI</a>`.
+
+For a more complete example including more features, see the :raw-html-m2r:`<a href="https://typer.tiangolo.com/tutorial/">Tutorial - User Guide</a>`.
+
+Optional Dependencies
+---------------------
+
+Typer uses :raw-html-m2r:`<a href="https://click.palletsprojects.com/" class="external-link" target="_blank">Click</a>` internally. That's the only dependency.
+
+But you can also install extras:
+
+
+* :raw-html-m2r:`<a href="https://pypi.org/project/colorama/" class="external-link" target="_blank"><code>colorama</code></a>`\ : and Click will automatically use it to make sure your terminal's colors always work correctly, even in Windows.
+
+  * Then you can use any tool you want to output your terminal's colors in all the systems, including the integrated ``typer.style()`` and ``typer.secho()`` (provided by Click).
+  * Or any other tool, e.g. :raw-html-m2r:`<a href="https://pypi.org/project/wasabi/" class="external-link" target="_blank"><code>wasabi</code></a>`\ , :raw-html-m2r:`<a href="https://github.com/erikrose/blessings" class="external-link" target="_blank"><code>blessings</code></a>`.
+
+* :raw-html-m2r:`<a href="https://github.com/sarugaku/shellingham" class="external-link" target="_blank"><code>shellingham</code></a>`\ : and Typer will automatically detect the current shell when installing completion.
+
+  * With ``shellingham`` you can just use ``--install-completion``.
+  * Without ``shellingham``\ , you have to pass the name of the shell to install completion for, e.g. ``--install-completion bash``.
+
+You can install ``typer`` with ``colorama`` and ``shellingham`` with ``pip install typer[all]``.
+
+Other tools and plug-ins
+------------------------
+
+Click has many plug-ins available that you can use. And there are many tools that help with command line applications that you can use as well, even if they are not related to Typer or Click.
+
+For example:
+
+
+* :raw-html-m2r:`<a href="https://github.com/click-contrib/click-spinner" class="external-link" target="_blank"><code>click-spinner</code></a>`\ : to show the user that you are loading data. A Click plug-in.
+
+  * There are several other Click plug-ins at :raw-html-m2r:`<a href="https://github.com/click-contrib" class="external-link" target="_blank">click-contrib</a>` that you can explore.
+
+* :raw-html-m2r:`<a href="https://pypi.org/project/tabulate/" class="external-link" target="_blank"><code>tabulate</code></a>`\ : to automatically display tabular data nicely. Independent of Click or Typer.
+* :raw-html-m2r:`<a href="https://github.com/tqdm/tqdm" class="external-link" target="_blank"><code>tqdm</code></a>`\ : a fast, extensible progress bar, alternative to Typer's own ``typer.progressbar()``.
+* etc... you can re-use many of the great available tools for building CLIs.
+
+License
+-------
+
+This project is licensed under the terms of the MIT license.
diff -Nur a/setup.py b/setup.py
--- a/setup.py	1970-01-01 01:00:00.000000000 +0100
+++ b/setup.py	2020-06-14 13:03:51.180092891 +0100
@@ -0,0 +1,39 @@
+
+# -*- coding: utf-8 -*-
+
+# DO NOT EDIT THIS FILE!
+# This file has been autogenerated by dephell <3
+# https://github.com/dephell/dephell
+
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+
+import os.path
+
+readme = ''
+here = os.path.abspath(os.path.dirname(__file__))
+readme_path = os.path.join(here, 'README.rst')
+if os.path.exists(readme_path):
+    with open(readme_path, 'rb') as stream:
+        readme = stream.read().decode('utf8')
+
+
+setup(
+    long_description=readme,
+    name='typer',
+    version='0.2.1',
+    description='Typer, build great CLIs. Easy to code. Based on Python type hints.',
+    python_requires='>=3.6',
+    project_urls={"Documentation": "https://typer.tiangolo.com/", "homepage": "https://github.com/tiangolo/typer"},
+    author='Sebastián Ramírez',
+    author_email='tiangolo@gmail.com',
+    classifiers=['Intended Audience :: Information Technology', 'Intended Audience :: System Administrators', 'Operating System :: OS Independent', 'Programming Language :: Python :: 3', 'Programming Language :: Python', 'Topic :: Software Development :: Libraries :: Application Frameworks', 'Topic :: Software Development :: Libraries :: Python Modules', 'Topic :: Software Development :: Libraries', 'Topic :: Software Development', 'Typing :: Typed', 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', 'Programming Language :: Python :: 3 :: Only', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'License :: OSI Approved :: MIT License'],
+    packages=['typer'],
+    package_dir={"": "."},
+    package_data={"typer": ["*.typed"]},
+    install_requires=['click<7.2.0,>=7.1.1'],
+    extras_require={"all": ["colorama", "shellingham"], "dev": ["autoflake", "flake8"], "doc": ["markdown-include", "mkdocs", "mkdocs-material"], "test": ["black", "coverage", "isort", "mypy", "pytest<5.4,>=4.4.0", "pytest-cov", "pytest-sugar", "pytest-xdist", "shellingham"]},
+)