Giter VIP home page Giter VIP logo

collection_prep's Introduction

Collection Prep Engine

INSTALLATION

pip install .

CONTENT UPDATER

collection_prep_update -c arista.eos -p ./
INFO      -------------------Processing ./arista.eos/plugins/modules/eos_lacp.py
INFO      Updated metadata in ./arista.eos/plugins/modules/eos_lacp.py
INFO      Updated documentation in ./arista.eos/plugins/modules/eos_lacp.py
INFO      Found a resource module
INFO      Setting short desciption to 'LACP resource module'
INFO      Updated examples in ./arista.eos/plugins/modules/eos_lacp.py
INFO      Wrote ./arista.eos/plugins/modules/eos_lacp.py
INFO      Running black against ./arista.eos/plugins/modules/eos_lacp.py
INFO      -------------------Processing ./arista.eos/plugins/modules/eos_static_routes.py
INFO      Updated metadata in ./arista.eos/plugins/modules/eos_static_routes.py
INFO      Updated documentation in ./arista.eos/plugins/modules/eos_static_routes.py
INFO      Found a resource module
INFO      Setting short desciption to 'Static routes resource module'
INFO      Updated examples in ./arista.eos/plugins/modules/eos_static_routes.py
INFO      Wrote ./arista.eos/plugins/modules/eos_static_routes.py
INFO      Running black against ./arista.eos/plugins/modules/eos_static_routes.py
INFO      -------------------Processing ./arista.eos/plugins/action/__init__.py
WARNING   Failed to find DOCUMENTATION assignment
WARNING   Skipped ./arista.eos/plugins/action/__init__.py: No module name found

DOC GENERATOR

This is intended to operate against the repository clone.

This will generate an RST file for each plugin in the collection docs folder and add a table of links for all plugin types in the README.md

This will also pull the rewuires_ansible information from the runtime.yml file and add an ansible compatibility section to the README.

For the ansible compatibility, ensure the collection README.md has the following in it:

<!--start requires_ansible-->
<!--end requires_ansible-->

For the plugin table, ensure the collection README.md has the following in it:


<!--start collection content-->
<!--end collection content-->

collection_prep_add_docs -p ./ansible.netcommon
INFO      Setting collection name to ansible.netcommon
INFO      Setting github repository url to https://github.com/ansible-collections/ansible.netcommon
INFO      Linking collection to user collection directory
INFO      This is required for the Ansible fragment loader to find doc fragments
INFO      Attempting to remove existing /home/bthornto/.ansible/collections/ansible_collections/ansible/netcommon
INFO      Deleteing: /home/bthornto/.ansible/collections/ansible_collections/ansible/netcommon
INFO      Creating namepsace directory /home/bthornto/.ansible/collections/ansible_collections/ansible
INFO      Linking collection /home/bthornto/github/collection_update/ansible.netcommon -> /home/bthornto/.ansible/collections/ansible_collections/ansible/netcommon
INFO      Purging content from directory /home/bthornto/github/collection_update/ansible.netcommon/docs
INFO      Making docs directory /home/bthornto/github/collection_update/ansible.netcommon/docs
INFO      Process content in /home/bthornto/github/collection_update/ansible.netcommon/plugins/become
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/become/enable.py
INFO      Process content in /home/bthornto/github/collection_update/ansible.netcommon/plugins/connection
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/connection/httpapi.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/connection/network_cli.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/connection/netconf.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/connection/napalm.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/connection/persistent.py
INFO      Process content in /home/bthornto/github/collection_update/ansible.netcommon/plugins/filter
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/filter/ipaddr.py
INFO      Adding filter plugins cidr_merge,ipaddr,ipmath,ipwrap,ip4_hex,ipv4,ipv6,ipsubnet,next_nth_usable,network_in_network,network_in_usable,reduce_on_network,nthhost,previous_nth_usable,slaac,hwaddr,macaddr
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/filter/network.py
INFO      Adding filter plugins parse_cli,parse_cli_textfsm,parse_xml,type5_pw,hash_salt,comp_type5,vlan_parser
INFO      Process content in /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_l3_interface.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/restconf_get.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_l2_interface.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_static_route.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_linkagg.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_logging.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/telnet.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_system.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/cli_config.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_ping.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_banner.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_lldp.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_interface.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/restconf_config.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/netconf_config.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_vrf.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_lldp_interface.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/netconf_get.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/netconf_rpc.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_get.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_vlan.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_put.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/cli_command.py
INFO      Processing /home/bthornto/github/collection_update/ansible.netcommon/plugins/modules/net_user.py
INFO      Processing 'become' for README
INFO      Processing 'connection' for README
INFO      Processing 'filter' for README
INFO      Processing 'modules' for README
INFO      README.md updated
(venv) ➜  collection_update git:(master) ✗

meta/runtime.yml GENERATOR

This is intended to operate against the repository clone.

collection_prep_runtime -c arista.eos -p ./
INFO      -------------------Processing runtime.yml for module eos_acl_interfaces
INFO      -------------------Processing runtime.yml for module eos_acls
INFO      -------------------Processing runtime.yml for module eos_banner
INFO      -------------------Processing runtime.yml for module eos_bgp
INFO      -------------------Processing runtime.yml for module eos_command
INFO      -------------------Processing runtime.yml for module eos_config
INFO      -------------------Processing runtime.yml for module eos_eapi
INFO      -------------------Processing runtime.yml for module eos_facts
INFO      -------------------Processing runtime.yml for module eos_interface
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_interfaces
INFO      -------------------Processing runtime.yml for module eos_l2_interface
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_l2_interfaces
INFO      -------------------Processing runtime.yml for module eos_l3_interface
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_l3_interfaces
INFO      -------------------Processing runtime.yml for module eos_lacp
INFO      -------------------Processing runtime.yml for module eos_lacp_interfaces
INFO      -------------------Processing runtime.yml for module eos_lag_interfaces
INFO      -------------------Processing runtime.yml for module eos_linkagg
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_lldp
INFO      -------------------Processing runtime.yml for module eos_lldp_global
INFO      -------------------Processing runtime.yml for module eos_lldp_interfaces
INFO      -------------------Processing runtime.yml for module eos_logging
INFO      -------------------Processing runtime.yml for module eos_static_route
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_static_routes
INFO      -------------------Processing runtime.yml for module eos_system
INFO      -------------------Processing runtime.yml for module eos_user
INFO      -------------------Processing runtime.yml for module eos_vlan
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_vlans
INFO      -------------------Processing runtime.yml for module eos_vrf
INFO      -------------------Processing runtime.yml for module eos_acl_interfaces
INFO      -------------------Processing runtime.yml for module eos_acls
INFO      -------------------Processing runtime.yml for module eos_banner
INFO      -------------------Processing runtime.yml for module eos_bgp
INFO      -------------------Processing runtime.yml for module eos_command
INFO      -------------------Processing runtime.yml for module eos_config
INFO      -------------------Processing runtime.yml for module eos_eapi
INFO      -------------------Processing runtime.yml for module eos_facts
INFO      -------------------Processing runtime.yml for module eos_interface
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_interfaces
INFO      -------------------Processing runtime.yml for module eos_l2_interface
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_l2_interfaces
INFO      -------------------Processing runtime.yml for module eos_l3_interface
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_l3_interfaces
INFO      -------------------Processing runtime.yml for module eos_lacp
INFO      -------------------Processing runtime.yml for module eos_lacp_interfaces
INFO      -------------------Processing runtime.yml for module eos_lag_interfaces
INFO      -------------------Processing runtime.yml for module eos_linkagg
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_lldp
INFO      -------------------Processing runtime.yml for module eos_lldp_global
INFO      -------------------Processing runtime.yml for module eos_lldp_interfaces
INFO      -------------------Processing runtime.yml for module eos_logging
INFO      -------------------Processing runtime.yml for module eos_static_route
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_static_routes
INFO      -------------------Processing runtime.yml for module eos_system
INFO      -------------------Processing runtime.yml for module eos_user
INFO      -------------------Processing runtime.yml for module eos_vlan
INFO      Found to be deprecated
INFO      -------------------Processing runtime.yml for module eos_vlans
INFO      -------------------Processing runtime.yml for module eos_vrf

collection_prep's People

Contributors

akasurde avatar cidrblock avatar danielmellado avatar ganeshrn avatar goneri avatar jborean93 avatar jillr avatar kenchrcum avatar nilashishc avatar nitzmahone avatar pabelanger avatar qalthos avatar samccann avatar zloesabo avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.