Debian Codegraph @

debian/control

raw
1 Source: python-cyclopts
2 Section: python
3 Maintainer: Debian Python Team <[email protected]>
4 Uploaders:
5 Josenilson Ferreira da Silva <[email protected]>,
6 Build-Depends:
7 debhelper-compat (= 13),
8 dh-sequence-python3,
9 dh-sequence-sphinxdoc,
10 pybuild-plugin-pyproject,
11 python3-all,
12 python3-setuptools,
13 Build-Depends-Indep:
14 mkdocs <!nocheck>,
15 python-pytest-doc <!nodoc>,
16 python3-attr,
17 python3-docstring-parser,
18 python3-hatch-vcs,
19 python3-hatchling,
20 python3-linkify-it <!nodoc>,
21 python3-myst-parser <!nodoc>,
22 python3-pydantic <!nocheck>,
23 python3-pytest <!nocheck>,
24 python3-pytest-mock <!nocheck>,
25 python3-rich,
26 python3-rich-rst,
27 python3-sniffio <!nocheck>,
28 python3-sphinx <!nodoc>,
29 python3-sphinx-autodoc-typehints <!nodoc>,
30 python3-sphinx-copybutton <!nodoc>,
31 python3-sphinx-rtd-theme <!nodoc>,
32 python3-syrupy <!nocheck>,
33 python3-trio <!nocheck>,
34 python3-typing-extensions,
35 python3-yaml,
36 Standards-Version: 4.7.4
37 Homepage: https://github.com/BrianPugh/cyclopts
38 Vcs-Browser: https://salsa.debian.org/python-team/packages/python-cyclopts
39 Vcs-Git: https://salsa.debian.org/python-team/packages/python-cyclopts.git
40 Testsuite: autopkgtest-pkg-pybuild
41
42 Package: python3-cyclopts
43 Architecture: all
44 Depends:
45 ${misc:Depends},
46 ${python3:Depends},
47 Suggests:
48 python-cyclopts-doc,
49 Description: Command line interface structure
50 Package is a modern and easy-to-use framework for building command-line
51 interfaces (CLIs) in Python, designed to make developing CLI applications
52 simpler, more intuitive, and efficient.
53 .
54 It stands out for:
55 - Use of Python Type Annotations: Cyclopts leverages Python’s type annotation
56 system to make the CLI code more readable and less error-prone. You can use
57 native Python types to specify inputs, such as int, str, and float, as well
58 as more complex types like Pydantic, Dataclasses, and Attrs, improving
59 clarity and control over input parameters.
60 - Intuitive and Simple Interface: Cyclopts is designed to be easy to learn and
61 use. The syntax is extremely simple, allowing developers to quickly build
62 command-line tools with minimal code. Setting up commands, options, and
63 arguments is straightforward, without the need for complex configurations
64 or boilerplate code.
65 - Automatic Validation and Type Conversion: Cyclopts handles automatic
66 validation and type conversion based on the defined types in the code.
67 This means it automatically validates input values according to type
68 annotations and converts the inputs to the correct types without requiring
69 extra code from the developer, reducing the chance of user input errors.
70 - Automatic Help Generation: Cyclopts automatically generates detailed,
71 well-structured help pages for your commands and options, using docstrings
72 and the information provided in type definitions. This makes it easy to
73 create user-friendly interfaces and eliminates the need to manually
74 maintain CLI documentation.
75 - Extensibility and Customization: Cyclopts is highly extensible. It allows
76 developers to customize how input data is parsed, validated, and processed.
77 The framework supports the creation of custom converters and validators,
78 offering great flexibility to adapt the application to specific project
79 needs.
80 - Integration with Existing Tools: Cyclopts integrates seamlessly with other
81 popular Python libraries and frameworks. It can be used alongside libraries
82 like Pydantic for data validation or Typer and Click to build more complex
83 applications, all while maintaining its simplicity and focus on usability.
84 - Clear and Detailed Documentation: Cyclopts has clear, concise documentation
85 with practical examples that make it easy to adopt, even for beginners.
86 This is an important advantage, as building CLI tools can be complex, and
87 Cyclopts’ documentation makes this process more accessible.
88
89 Package: python-cyclopts-doc
90 Section: doc
91 Architecture: all
92 Multi-Arch: foreign
93 Depends:
94 ${misc:Depends},
95 ${sphinxdoc:Depends},
96 Description: command line interface structure (common documentation)
97 Package is a modern and easy-to-use framework for building command-line
98 interfaces (CLIs) in Python, designed to make developing CLI applications
99 simpler, more intuitive, and efficient.
100 .
101 It stands out for:
102 - Use of Python Type Annotations: Cyclopts leverages Python’s type annotation
103 system to make the CLI code more readable and less error-prone. You can use
104 native Python types to specify inputs, such as int, str, and float, as well
105 as more complex types like Pydantic, Dataclasses, and Attrs, improving
106 clarity and control over input parameters.
107 - Intuitive and Simple Interface: Cyclopts is designed to be easy to learn and
108 use. The syntax is extremely simple, allowing developers to quickly build
109 command-line tools with minimal code. Setting up commands, options, and
110 arguments is straightforward, without the need for complex configuration
111 or boilerplate code.
112 - Automatic Validation and Type Conversion: Cyclopts handles automatic
113 validation and type conversion based on the defined types in the code.
114 This means it automatically validates input values according to type
115 annotations and converts the inputs to the correct types without requiring
116 extra code from the developer, reducing the chance of user input errors
117 - Automatic Help Generation: Cyclopts automatically generates detailed,
118 well-structured help pages for your commands and options, using docstrings
119 and the information provided in type definitions. This makes it easy to
120 create user-friendly interfaces and eliminates the need to manually
121 maintain CLI documentation.
122 - Extensibility and Customization: Cyclopts is highly extensible. It allows
123 developers to customize how input data is parsed, validated, and processed.
124 The framework supports the creation of custom converters and validators,
125 offering great flexibility to adapt the application to specific project
126 needs.
127 - Integration with Existing Tools: Cyclopts integrates seamlessly with other
128 popular Python libraries and frameworks. It can be used alongside libraries
129 like Pydantic for data validation or Typer and Click to build more complex
130 applications, all while maintaining its simplicity and focus on usability.
131 - Clear and Detailed Documentation: Cyclopts has clear, concise documentation
132 with practical examples that make it easy to adopt, even for beginners.
133 This is an important advantage, as building CLI tools can be complex, and
134 Cyclopts’ documentation makes this process more accessible.
135 .
136 This is the common documentation package.