Skip to content

Commit

Permalink
Updated copyright notice
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertBlackhart committed Jul 29, 2024
1 parent bf7be3a commit 6d4de04
Show file tree
Hide file tree
Showing 35 changed files with 58 additions and 24 deletions.
2 changes: 2 additions & 0 deletions examples/async.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This application has some commands that can run in the background and some in
the foreground only.
"""
Expand Down
2 changes: 2 additions & 0 deletions examples/cake.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
A simple application for making and listing the cakes we have
"""

Expand Down
2 changes: 2 additions & 0 deletions examples/hello.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
A "hello world" application for CLI commands
"""

Expand Down
2 changes: 2 additions & 0 deletions examples/ls
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024

An example of how you might implement a unix style CLI command using recline
"""

Expand Down
3 changes: 1 addition & 2 deletions recline/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2020 NetApp Inc.
All rights reserved.
Original © NetApp 2024
"""

import os
Expand Down
2 changes: 2 additions & 0 deletions recline/arg_types/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This package contains the various custom type definitions for CLI command parameters.
If you are defining a CLI command function that takes input with restrictions,
you may want to use a type annotation to allow recline to do the checking for you
Expand Down
2 changes: 2 additions & 0 deletions recline/arg_types/choices.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
A Choices type allows the CLI command writer to specify a static list of choices
for a parameter. Once the body of the function is invoked, it is guaranteed that
the validation was done on the parameter to make sure it matched one.
Expand Down
2 changes: 2 additions & 0 deletions recline/arg_types/flag.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
A Flag type allows the CLI command writer to specify an argument that behaves
like a boolean flag. The difference between this and declaring an argument as a
bool is that no "true" or "false" input is expected of the user if the argument
Expand Down
2 changes: 2 additions & 0 deletions recline/arg_types/positional.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
A Positional type allows the CLI command writer to specify an argument that the
user will provide positionally. That is, instead of the user typing
"-arg_name argvalue", they can just type "argvalue". For example:
Expand Down
2 changes: 2 additions & 0 deletions recline/arg_types/ranged_int.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
A RangedInt type allows the CLI command writer to specify an integer that is only
valid within a certain range. If the user provides a value outside of that range,
then the parameter validation will fail and they will receive an error message.
Expand Down
2 changes: 2 additions & 0 deletions recline/arg_types/recline_type.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This module contains the abstract base class for all recline custom types
"""

Expand Down
2 changes: 2 additions & 0 deletions recline/arg_types/recline_type_error.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This module contains the error class that is raised when there is a type error
when validating user input.
"""
Expand Down
2 changes: 2 additions & 0 deletions recline/arg_types/remainder.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
A Remainder type allows the CLI command writer to specify that an argument should
consume all of the rest of the input from the CLI and that it will be interpreted
inside of the command handler function.
Expand Down
2 changes: 2 additions & 0 deletions recline/commands/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This package contains the base command class and the builtin command for all
recline-based applications to use.
"""
Expand Down
2 changes: 2 additions & 0 deletions recline/commands/async_command.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This is the implementation of an async command for the recline library. It allows
for a command to be run in the foreground or background.
"""
Expand Down
2 changes: 2 additions & 0 deletions recline/commands/builtin_commands.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
The commands defined here are included with every recline application
"""

Expand Down
2 changes: 2 additions & 0 deletions recline/commands/cli_command.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This module contains the definition of a CLICommand object. This is the main
driver of the recline library. Essentially, a CLICommand takes as input a wrapped
function and parses the args and docstring so that when called from the REPL, the
Expand Down
2 changes: 2 additions & 0 deletions recline/commands/man_utils.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This module holds some utility functions used as part of the man command to format
text from CLI commands into consistent man pages that respond to the terminal
width.
Expand Down
2 changes: 2 additions & 0 deletions recline/formatters/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This package contains useful output formatters. An output formatter can be defined
as the return type of a CLI command (using a type annotation). If one is defined,
then the result of running the command will be passed to the output formatter
Expand Down
2 changes: 2 additions & 0 deletions recline/formatters/output_formatter.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This module contains the abstract class that all other output formatters should
inherit from
"""
Expand Down
2 changes: 2 additions & 0 deletions recline/formatters/table_formatter.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This module contains a table formatter for CLI output. The table formatter expects
output to be an iterable of dictionary-like objects. For example, if a CLI command
returned something like:
Expand Down
2 changes: 2 additions & 0 deletions recline/repl/completer.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This module implements a readline completer for completing command names as well
as argument names and values.
"""
Expand Down
2 changes: 2 additions & 0 deletions recline/repl/shell.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
This is the main staring point for a recline application
"""

Expand Down
2 changes: 2 additions & 0 deletions tests/conftest.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Original © NetApp 2024
pytest configuration for recline unit tests
"""

Expand Down
3 changes: 1 addition & 2 deletions tests/test_arg_types/test_choices.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.arg_types.choices module
"""
Expand Down
3 changes: 1 addition & 2 deletions tests/test_arg_types/test_cliche_type.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.arg_types.recline_type module
"""
Expand Down
3 changes: 1 addition & 2 deletions tests/test_arg_types/test_positional.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.arg_types.positional module
"""
Expand Down
3 changes: 1 addition & 2 deletions tests/test_arg_types/test_ranged_int.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.arg_types.ranged_int module
"""
Expand Down
3 changes: 1 addition & 2 deletions tests/test_commands/test_async_command.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.commands.async_command module
"""
Expand Down
3 changes: 1 addition & 2 deletions tests/test_commands/test_builtin_commands.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.commands.builtin_commands module
"""
Expand Down
3 changes: 1 addition & 2 deletions tests/test_commands/test_cli_command.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.commands.cli_command module
"""
Expand Down
3 changes: 1 addition & 2 deletions tests/test_commands/test_man_utils.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.commands.man_utils module
"""
Expand Down
3 changes: 1 addition & 2 deletions tests/test_formatters/test_table_formatter.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.formatters module
"""
Expand Down
3 changes: 1 addition & 2 deletions tests/test_repl/test_completer.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.repl.completer module
"""
Expand Down
3 changes: 1 addition & 2 deletions tests/test_repl/test_shell.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Copyright (C) 2019 NetApp Inc.
All rights reserved.
Original © NetApp 2024
A test module for the recline.repl.shell module
"""
Expand Down

0 comments on commit 6d4de04

Please sign in to comment.