# pyATS Contribution Package
The `pyats.contrib` package is a collection of open-source extensions for the
pyATS framework.
Plugins, extensions and codes under this project are designed to automatically
integrate into the pyATS framework using its various published hook/entry-point
interfaces.
## General Information
- Website: https://developer.cisco.com/pyats/
- Documentation: https://developer.cisco.com/docs/pyats/
- Support: pyats-support-ext@cisco.com
## Installation
This package is automatically installed when you perform a full pyATS
installation. Alternatively, you can install this package separately, if you
have a more light-weight pyATS install:
```
# when using full-install, this package is included by default
$ pip install pyats[full]
# to install separately
$ pip install pyats.contrib
```
## Solution Documentation
For now, each individual folder under `src/` has its own README.md file.
We are working on a better hosting solution for all documentation related to
this repository.
## Contributions
Everyone is welcomed to pitch-in, collaborate, contribute and improve upon
what's here, and or introduce new ideas and plugins. The goal of this package is
three-fold:
- to introduce a place where the pyATS development team can open-source
bits and pieces of the framework
- to provide a location for community members to collaborate together,
centrally
- to document and demonstrate, via examples, the various plugins and hook
capabilities the framework has to offer.
Please consider the following when contributing to this repository:
- minimize dependencies as much as possible; use lazy-loading where possible.
Eg: adding a pip installation dependency will impact ALL users that install
this package, where as adding an import dependency, with try/except around it,
and printing a nice error message indicating you need package X installed to
enable this feature, allows selectively installation of dependencies per
what's needed
- include unit-tests and documentation for everything you develop
Raw data
{
"_id": null,
"home_page": "https://developer.cisco.com/pyats/",
"name": "pyats.contrib",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "genie pyats test automation open source contrib",
"author": "Cisco Systems Inc.",
"author_email": "pyats-support-ext@cisco.com",
"download_url": null,
"platform": null,
"description": "# pyATS Contribution Package\n\nThe `pyats.contrib` package is a collection of open-source extensions for the\npyATS framework. \n\nPlugins, extensions and codes under this project are designed to automatically\nintegrate into the pyATS framework using its various published hook/entry-point\ninterfaces.\n\n## General Information\n\n- Website: https://developer.cisco.com/pyats/\n- Documentation: https://developer.cisco.com/docs/pyats/\n- Support: pyats-support-ext@cisco.com\n\n## Installation\n\nThis package is automatically installed when you perform a full pyATS \ninstallation. Alternatively, you can install this package separately, if you \nhave a more light-weight pyATS install:\n\n```\n# when using full-install, this package is included by default\n$ pip install pyats[full]\n\n\n# to install separately\n$ pip install pyats.contrib\n```\n\n## Solution Documentation\n\nFor now, each individual folder under `src/` has its own README.md file.\nWe are working on a better hosting solution for all documentation related to \nthis repository.\n\n## Contributions\n\nEveryone is welcomed to pitch-in, collaborate, contribute and improve upon \nwhat's here, and or introduce new ideas and plugins. The goal of this package is\nthree-fold:\n\n - to introduce a place where the pyATS development team can open-source\n bits and pieces of the framework\n\n - to provide a location for community members to collaborate together, \n centrally\n\n - to document and demonstrate, via examples, the various plugins and hook \n capabilities the framework has to offer.\n\nPlease consider the following when contributing to this repository:\n\n- minimize dependencies as much as possible; use lazy-loading where possible.\n Eg: adding a pip installation dependency will impact ALL users that install\n this package, where as adding an import dependency, with try/except around it,\n and printing a nice error message indicating you need package X installed to\n enable this feature, allows selectively installation of dependencies per \n what's needed\n\n- include unit-tests and documentation for everything you develop\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Open source package for pyATS framework extensions.",
"version": "24.3",
"project_urls": {
"Homepage": "https://developer.cisco.com/pyats/"
},
"split_keywords": [
"genie",
"pyats",
"test",
"automation",
"open",
"source",
"contrib"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a325a78230d3d488d77ae6f7e8bb32759b4e7ec26dab04773055006567e1976",
"md5": "270350c53d575bb182ba247017027f7f",
"sha256": "41cd7fda194ef44a846b0a33b9f2305bdb16c01a65b5c13b9a5c847356fb8613"
},
"downloads": -1,
"filename": "pyats.contrib-24.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "270350c53d575bb182ba247017027f7f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 56273,
"upload_time": "2024-03-26T18:33:28",
"upload_time_iso_8601": "2024-03-26T18:33:28.769109Z",
"url": "https://files.pythonhosted.org/packages/4a/32/5a78230d3d488d77ae6f7e8bb32759b4e7ec26dab04773055006567e1976/pyats.contrib-24.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 18:33:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyats.contrib"
}
JSON