https://github.com/tybruno/commands_reader

https://github.com/tybruno/commands_reader

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/tybruno/commands_reader
• Owner: tybruno
• License: mit
• Created: 2021-08-06T19:03:49.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-06T20:01:02.000Z (over 3 years ago)
• Last Synced: 2024-10-18T14:29:41.796Z (2 months ago)
• Language: Python
• Size: 4.88 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# commands_reader

Read a list of commands from a .txt file or a string.

#### Key Features:

* **Easy**: Designed to easily retrieve a list of hosts from a file or string.

* **There is More!!!**:

    * [hosts_reader](https://github.com/tybruno/hosts_reader): Read a list of hosts from a file or string.

    * [text_file_reader](https://github.com/tybruno/text_file_reader): Library that makes reading text files easy.

    * [file_reader](https://github.com/tybruno/file_reader): Created an abstraction for reading multiple types of files that hosts_reader, commands_reader, and text_file_reader inherit from.

### Usage

#### File example

commands.txt

```text

show cdp nei, show run | inc boot

```

commands2.txt

```text

show cdp neigh

show run | inc boot

```

```python

from commands_reader import CommandsFileReader

commands_file = "commands2.txt"

read_hosts_file = CommandsFileReader()

commands = read_hosts_file(commands_file)

print(tuple(commmands)) # ('show cdp nei', 'show run | inc boot')

```

#### String Example

```python

from commands_reader import CommandsParser

commands_str = "show cdp nei, show run | inc boot"

parse_commands = CommandsParser()

commands = parse_commands(commands_str)

print(list(commands)) # ['show cdp nei', 'show run | inc boot']

```

### Road Map

* Add support for excel files

* Add support for csv files