|
1 | | -# CloudShell package repo template |
| 1 | +# cloudshell-networking-ipinfusion |
2 | 2 |
|
3 | | -[](https://github.com/QualiSystems/cloudshell-package-repo-template/actions?query=branch%3Amaster) |
4 | | -[](https://codecov.io/gh/QualiSystems/cloudshell-package-repo-template) |
5 | | -[](https://pypi.org/project/cloudshell-template) |
6 | | -[](https://github.com/python/black) |
| 3 | +[](https://travis-ci.org/QualiSystems/cloudshell-networking-ipinfusion) |
| 4 | +[](https://codecov.io/gh/QualiSystems/cloudshell-networking-ipinfusion) |
| 5 | +[](https://badge.fury.io/py/cloudshell-networking-ipinfusion) |
| 6 | +[](https://dependencyci.com/github/QualiSystems/cloudshell-networking-ipinfusion) |
7 | 7 |
|
8 | | -Use this template to create new shell packages. |
9 | | - |
10 | | -## Description of services |
11 | | -### tox |
12 | | -[tox](https://pypi.org/project/tox/) is an open source tool we use to run tests in multiple virtual environments. |
13 | | -* To run all tests described in tox.ini, just run `tox`. |
14 | | -* To run a particular env use `tox -e env_name`. |
15 | | - |
16 | | -### pre-commit |
17 | | -[pre-commit](https://pypi.org/project/pre-commit/) is an open source library we use to manage pre-commit hooks. |
18 | | -* Run all code linters with a command `pre-commit run --all-files`. |
19 | | -* Add git hook with command `pre-commit install`. |
20 | | -* To update versions of pre-commit hooks in config file run `pre-commit autoupdate` |
21 | | - |
22 | | -We use these hooks: |
23 | | -* **isort** sorts imports (config in tox.ini) |
24 | | -* **black** reformats code to one style (config in pyproject.toml) |
25 | | -* **flake8** checks code style (config in tox.ini). We use these plugins: |
26 | | - * `flake8-docstring` to check docstrings |
27 | | - * `flake8-builtins` to avoid using builtins as variable names |
28 | | - * `flake8-comprehensions` to check list/dict comprehensions |
29 | | - * `flake8-print` to ensure we don't leave prints in the code |
30 | | - * `flake8-eradicate` to ensure we don't leave commented lines in the code |
31 | | - |
32 | | -## Installation |
33 | | - |
34 | | -### tox.ini |
35 | | -* Set the `package-name` var regarding your package. |
36 | | -* Set the python version in envlist. |
37 | | - |
38 | | -### .travis.yml |
39 | | -* Set the python version regarding tox.ini. |
40 | | - |
41 | | -### pyproject.toml |
42 | | -* Set the python version for black. |
43 | | - |
44 | | -### setup.py |
45 | | -* Set a name and description for the package. |
46 | | -* Set the python version of the shell. |
47 | | - |
48 | | -### README.md |
49 | | -* Update links for build, coverage etc. |
50 | | -* Add the line to README |
51 | | - We use tox and pre-commit for testing. [Services description](https://github.com/QualiSystems/cloudshell-package-repo-template#description-of-services) |
| 8 | +<p align="center"> |
| 9 | +<img src="https://github.com/QualiSystems/devguide_source/raw/master/logo.png"></img> |
| 10 | +</p> |
0 commit comments