Merge pull request #16 from InfrastructureAsCode-ch/develop

Release TUI and YAML command

Author: ubaumann

.github/workflows/main.yaml

@@ -49,7 +49,7 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [ '3.8', '3.9', '3.10' ]
-        platform: [ubuntu-latest, macOS-10.15, windows-latest]
+        platform: [ubuntu-latest, macOS-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
       - uses: actions/checkout@v2
@@ -78,7 +78,7 @@ jobs:
         if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
 
       - name: Run pytest
-        run: make pytest
+        run: poetry run pytest -vs
 
   pytest_extras:
     name: Testing ${{ matrix.extra }} on Python ${{ matrix.python-version }} (${{ matrix.platform}}) 
@@ -89,7 +89,7 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [ '3.8', '3.9', '3.10' ]
-        platform: [ubuntu-latest, macOS-10.15, windows-latest]
+        platform: [ubuntu-latest, macOS-latest, windows-latest]
         extra: [ 'jinja', 'ttp']
     runs-on: ${{ matrix.platform }}
     steps:

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to NetTowel
+
+Contributions are highly welcomed and appreciated!
+
+## Development Environment
+
+NetTowel uses [poetry](https://python-poetry.org/docs/) for packaging and
+dependency management.
+
+### Tests
+
+NetTowel uses [`pytest`](https://docs.pytest.org/) testing tool 
+Run tests with the following command:
+
+```
+make pytest
+```
+
+Make sure to test new code and not break existing tests.
+
+### Type Checking
+
+NetTowel uses type annotations and `mypy` is used as a static type checker.
+Run the following to type check NetTowel:
+
+```
+make mypy
+```
+
+Please add type annotations for all new code.
+
+### Code Formatting
+
+NetTowel uses [`black`](https://github.com/psf/black) for code formatting.
+Run the following to check the formatting:
+
+```
+make black
+```
+
+### All Tests
+
+Before pushing a commit all tests should be run. 
+Run the following command:
+
+```
+make pytest
+```
+
+### Bump version
+
+The version can be updated with the following command:
+Steps: patch, minor, major, prepatch, preminor, premajor, prerelease.
+
+```bash
+make bump ARGS=patch
+```
+
+### Install branch from git with extras
+
+To install a branch with `pip` and be able to specify the extras use the following command:
+
+```bash
+pip install git+https://github.com/InfrastructureAsCode-ch/nettowel.git@<branch_name>#egg=nettowel[<extras>]
+```
+
+Example:
+
+```bash
+pip install git+https://github.com/InfrastructureAsCode-ch/nettowel.git@develop#egg=nettowel[full]
+```

Makefile

@@ -2,31 +2,38 @@ PROJECT=nettowel
 CODE_DIRS=${PROJECT} tests
 IMG_URL=https://raw.githubusercontent.com/InfrastructureAsCode-ch/nettowel/main/imgs/
 
+# Run pytest
 .PHONY: pytest
 pytest:
 	poetry run pytest -vs ${ARGS}
 
+# Check if the python code needs to be reformatted 
 .PHONY: black
 black:
 	poetry run black --check ${CODE_DIRS}
 
+# Python type check
 .PHONY: mypy
 mypy:
 	poetry run mypy ${CODE_DIRS}
 
+# Runn pytest, black and mypy
 .PHONY: tests
 tests: pytest black mypy
 
+# use "make bump ARGS=patch" to bump the version. ARGS can be patch, minor or major.
 .PHONY: bump
 bump:
 	poetry version ${ARGS}
 	sed -i -E "s|\"\b[0-9]+.\b[0-9]+.\b[0-9]+\"  # From Makefile|\"`poetry version -s`\"  # From Makefile|g" ${PROJECT}/__init__.py
 	sed -i -E "s|\"\b[0-9]+.\b[0-9]+.\b[0-9]+\"  # From Makefile|\"`poetry version -s`\"  # From Makefile|g" tests/test_${PROJECT}.py
 
+# Used in the pipeline to change the image urls befor publishing it on pypi.org
 .PHONY: fiximageurls
 fiximageurls:
 	sed -i "s|](imgs/|](${IMG_URL}|g" README.md
 
+# Create a new tag and push it to origin. This will triger the pipeline and a new release will be published
 .PHONY: tag
 tag:
 	git checkout main

README.md

@@ -1,6 +1,12 @@
-# nettowel
+[![PyPI versions](https://img.shields.io/pypi/pyversions/nettowel.svg)](https://pypi.python.org/pypi/nettowel/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![Downloads](https://pepy.tech/badge/nettowel)](https://pepy.tech/project/nettowel)
+
+# NetTowel
 Collection of useful network automation functions 
 
+
 > ⚠️ `nettowel` is under heavy construction and not production ready. Feedback is highly appreciated.
 
 
@@ -25,6 +31,7 @@ The following groups are available (more details in the pyproject.toml):
 - scrapli
 - nornir
 - pandas
+- tui
 
 ```bash
 pip install nettowel[jinja]
@@ -117,6 +124,16 @@ Many features are not implemented yet and many features will come.
 ![network info](imgs/network-info.png)
 
 
+### YAML
+
+#### load
+
+![yaml load](imgs/yaml-load.png)
+
+#### dump
+
+![yaml dump](imgs/yaml-dump.png)
+
 ### Help
 
 ![Help QRcode](imgs/nettowel-help.png)
@@ -134,28 +151,8 @@ A `dotenv` file can be used as a settings file. The file can also be provided wi
 ![piping](imgs/piping.png)
 
 
+### TUI
 
-## Building CLI Docs
-
-**At the moment `typer-cli` is not ready for typer 0.4.0**
-
-```
-typer nettowel/cli/main.py utils docs --name nettowel --output CLI.md
-```
-
-## Contributing
-
-### Run tests:
-
-```bash
-make tests
-```
-
-
-### Bump version:
+Using [Trogon](https://github.com/Textualize/trogon) a TUI (Terminal User Interface) can be generated to edit and run the NetTowel command.
 
-Steps: patch, minor, major, prepatch, preminor, premajor, prerelease.
-
-```bash
-make bump ARGS=patch
-```
+![TUI](imgs/trogon.png)

imgs/help.png

@@ -1 +1 @@
-__version__ = "0.5.0"  # From Makefile
+__version__ = "0.5.1"  # From Makefile