معرفی شرکت ها

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

توضیحات

ClickYaml reads a `.yaml` file and creates click Commands out of it.

ویژگی	مقدار
سیستم عامل	-
نام فایل	clickyaml-2.1.0
نام	clickyaml
نسخه کتابخانه	2.1.0
نگهدارنده	[]
ایمیل نگهدارنده	[]
نویسنده	Vandit Goel
ایمیل نویسنده	vandy.goel23@gmail.com
آدرس صفحه اصلی	https://github.com/vandyG/clickyaml
آدرس اینترنتی	https://pypi.org/project/clickyaml/
مجوز	MIT license

========= clickYaml ========= .. image:: https://img.shields.io/pypi/v/clickyaml.svg :target: https://pypi.python.org/pypi/clickyaml .. image:: https://readthedocs.org/projects/clickyaml/badge/?version=latest :target: https://clickyaml.readthedocs.io/en/latest/?version=latest :alt: Documentation Status .. image:: https://github.com/vandyG/clickyaml/actions/workflows/python-package.yml/badge.svg?event=push&branch=master :target: https://github.com/vandyG/clickyaml/actions/workflows/python-package.yml/badge.svg ClickYaml reads a `.yaml` file and creates click Commands out of it. * Free software: MIT license * Documentation: https://clickyaml.readthedocs.io. Installation ------------ Stable release ^^^^^^^^^^^^^^ To install clickYaml, run this command in your terminal: .. code-block:: console $ pip install clickyaml This is the preferred method to install clickYaml, as it will always install the most recent stable release. If you don't have `pip`_ installed, this `Python installation guide`_ can guide you through the process. .. _pip: https://pip.pypa.io .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ From sources ^^^^^^^^^^^^ The sources for clickYaml can be downloaded from the `Github repo`_. You can either clone the public repository: .. code-block:: console $ git clone git://github.com/vandyG/clickyaml Or download the `tarball`_: .. code-block:: console $ curl -OJL https://github.com/vandyG/clickyaml/tarball/master Once you have a copy of the source, you can install it with: .. code-block:: console $ python setup.py install .. _Github repo: https://github.com/vandyG/clickyaml .. _tarball: https://github.com/vandyG/clickyaml/tarball/master Usage -------- Input ``yaml`` file example: .. code-block:: yaml simplecommand: script: "/home/user/scripts/simplecommand.bash" params: - !arg param_decls: [argument] - !opt param_decls: ["--option"] complexcommand: script: "/home/user/scripts/complexcommand.bash" help: "Complex Command" params: - !arg param_decls: [id] - !arg param_decls: [type] - !arg param_decls: [category] type: !obj class: click.Choice choices: ["1","2","3","ALL"] case_sensitive: False - !opt param_decls: ["--email","-E"] multiple: True envvar: MY_EMAIL help: "Specify the mailing list with this option" **Note**: There are certain rules on the structure of the yaml file: - Each command block needs to have blocks for each *parameter* of the command that you define. To know the available parameters refer to the `click documentation <https://click.palletsprojects.com/en/8.1.x/api/#click.Command>`_ - Apart from parameters to click.Command a *script* block can also be used. Script represents a script that you want to link with your command. - There are three types of tags that can be used in the yaml file: `!obj`, `!arg` and `!opt` - **!obj** can be used to create custom objects - **!arg** can be used to create ``click.Argument`` objects - **!opt** can be used to create ``click.Option`` objects The ``clickyaml`` module takes in the yaml file and creates ``Commander()`` objects for each command. A ``Commander()`` object houses the command, scripts associated with the command and the callback. There are two ways to get the commands from yaml data as **click.Command** objects: 1. Using get_command() 2. Using get_commanders() Get specific commands from the yaml file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: python from clickyaml import get_command, parse_yaml parsed_yaml = parse_yaml(path=path_to_yaml) # this command has a default callback that runs the script associated with the command command_default = get_command(name="simplecommand",parsed_yaml=parsed_yaml,) #this command has custom callback that prints the passed arguments cstm_clbk = lambda **kwargs: print(kwargs) command_custom = get_command(name="simplecommand",parsed_yaml=parsed_yaml,callback=cstm_clbk) Get all the Commander objects yaml file in a dictionary ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ *all the commands will be assigned the default callback* .. code-block:: python from clickyaml import get_commanders commanders = get_commanders(yaml=yaml_data) # returns all the commands in a dictionary simplecommand = commanders["simplecommand"].command complexcommand = commanders["complexcommand"].command Credits ------- This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage ======= History ======= 0.1.0 (2023-02-03) ------------------ * First release on PyPI.

نیازمندی

مقدار	نام
>=7.0	Click
-	python-dotenv
-	pyyaml

زبان مورد نیاز

مقدار	نام
>=3.7	Python

نحوه نصب

نصب پکیج whl clickyaml-2.1.0:

pip install clickyaml-2.1.0.whl

نصب پکیج tar.gz clickyaml-2.1.0:

pip install clickyaml-2.1.0.tar.gz