Ravenports generated: 22 Oct 2023 19:35
[ravenports.git] / bucket_A1 / python-nornir
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-nornir
4 VERSION=                3.4.1
5 KEYWORDS=               python
6 VARIANTS=               v11 v12
7 SDESC[v11]=             Automation framework to manage devices (3.11)
8 SDESC[v12]=             Automation framework to manage devices (3.12)
9 HOMEPAGE=               https://github.com/nornir-automation/nornir
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/a8/d5/37cd8193061916a023f17d5cff70a9bfc8a7dfff1b075828eb5888f72c95
14 DISTFILE[1]=            nornir-3.4.1-py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[v11]=             single
17 SPKGS[v12]=             single
18
19 OPTIONS_AVAILABLE=      PY311 PY312
20 OPTIONS_STANDARD=       none
21 VOPTS[v11]=             PY311=ON PY312=OFF
22 VOPTS[v12]=             PY311=OFF PY312=ON
23
24 DISTNAME=               nornir-3.4.1.dist-info
25
26 GENERATED=              yes
27
28 [PY311].RUN_DEPENDS_ON=                 python-mypy-extensions:single:v11
29                                         python-ruamel.yaml:single:v11
30 [PY311].USES_ON=                        python:v11,wheel
31
32 [PY312].RUN_DEPENDS_ON=                 python-mypy-extensions:single:v12
33                                         python-ruamel.yaml:single:v12
34 [PY312].USES_ON=                        python:v12,wheel
35
36 [FILE:2993:descriptions/desc.single]
37 ![Build Status] [![Code style: black]](https://github.com/ambv/black)
38 [Coverage Status]
39
40 Nornir
41 =======
42
43 ![logo][logo]
44
45 Nornir is a pure Python automation framework intented to be used directly
46 from Python. While most automation frameworks use their own Domain Specific
47 Language (DSL) which you use to describe what you want to have done, Nornir
48 lets you control everything from Python.
49
50 One of the benefits we want to highlight with this approach is the ease of
51 troubleshooting, if something goes wrong you can just use your existing
52 debug tools directly from Python (just add a line of `import pdb` &
53 `pdb.set_trace()` and you're good to go). Doing the same using a DSL can be
54 quite time consuming.
55
56 What Nornir brings to the table is that it takes care of dealing with your
57 inventory and manages the job of dispatching the tasks you want to run
58 against your nodes and devices. The framework provides a very simple way to
59 write plugins if you aren't happy with the ones we ship. Of course if you
60 have written a plugin you think can be useful to others, please send us
61 your code and test cases as a [pull request].
62
63 Install
64 =======
65
66 Please note that Nornir requires Python 3.7 or higher. Install Nornir with
67 pip.
68
69 `
70 pip install nornir
71 `
72
73 Plugins
74 -------
75
76 Since version 3.0.0 nornir doesn't ship with plugins, instead you can rely
77 on `pip` to install them for you. You can find a non-exhaustive list of
78 plugins in the following URL:
79
80 https://nornir.tech/nornir/plugins/
81
82 If you wrote a plugin and want to add it to the list don't hesitate to [add
83 it yourself]
84
85 Development version
86 -------------------
87
88 If you want to clone the repo and install it from there you will need to
89 use [poetry].
90
91 Documentation
92 =============
93
94 Read the [Nornir documentation] online or review its [code here]
95
96 Examples
97 ========
98
99 You can find some examples and already made tools [here]
100
101 External Resources
102 ==================
103
104 Below you can find links to talks, blog posts, podcasts and other
105 resources:
106
107 * April 2019 - Packet Pushers podcast - [Heavy Networking 445: An
108 Introduction To The Nornir Automation Framework]
109 * May 2018 - Software Gone Wild podcast - [IPSpace podcast about nornir]
110 * Sep 2018 - IPSpace network automation solutions - [Nornir workshop]
111 ([slides])
112 * May 2018 - Networklore - [Introducing Nornir - The Python automation
113 framework]
114 * May 2018 - Cisco blogs - [Exploring Nornir, the Python Automation
115 Framework]
116
117 Bugs & New features
118 ===================
119
120 If you think you have bug or would like to request a new feature, please
121 register a GitHub account and [open an issue].
122
123 Contact & Support
124 =================
125
126 Official channel for communicating issues is via [GitHub issues] and you
127 can use [GitHub discussions] for general discussions around nornir. In
128 addition, you can join the community in our ``#nornir`` channel in the
129 [networktoCode Slack team].
130
131 Contributing to Nornir
132 =======================
133
134 If you want to help the project, the [Contribution Guidelines] is the best
135 place to start.
136
137
138
139 [FILE:108:distinfo]
140 db079cb95e3baf855530f4f40cb6ee93f93e1bf3cb74ac08180546adb1b987b8        30548 nornir-3.4.1-py3-none-any.whl
141