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 + +
++ Typer, build great CLIs. Easy to code. Based on Python type hints. +
+ + + +---- + +**Documentation**\ : :raw-html-m2r:`https://typer.tiangolo.com` + +**Source Code**\ : :raw-html-m2r:`https://github.com/tiangolo/typer` + +---- + +Typer is library for building :raw-html-m2r:`CLI` 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:`Completion` 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:`` + +**Typer** is :raw-html-m2r:`FastAPI`\ '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:`Click`. + +Installation +------------ + + +.. raw:: html + +colorama
`\ : 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:`wasabi
`\ , :raw-html-m2r:`blessings
`.
+
+* :raw-html-m2r:`shellingham
`\ : 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:`click-spinner
`\ : to show the user that you are loading data. A Click plug-in.
+
+ * There are several other Click plug-ins at :raw-html-m2r:`click-contrib` that you can explore.
+
+* :raw-html-m2r:`tabulate
`\ : to automatically display tabular data nicely. Independent of Click or Typer.
+* :raw-html-m2r:`tqdm
`\ : 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"]},
+)