Skip to content

Commit 6d93306

Browse files
committed
Merge branch 'master' of github.com:banyansecurity/pybanyan
2 parents 3bf9133 + 4598062 commit 6d93306

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Python 3.6, 3.7, or 3.8 must be installed.
66
## Installation
77
### Installing the easy way
88

9-
```
9+
```console
1010
$ pip install pybanyan
1111
```
1212

1313
### Installing the hard way
1414

15-
```
15+
```console
1616
$ git clone https://github.com/banyansecurity/pybanyan.git
1717
$ cd pybanyan
1818
$ pip install -r requirements.txt
@@ -36,7 +36,7 @@ refresh_token = MY_API_TOKEN
3636

3737
Run the command `banyan` by itself to see the available categories.
3838

39-
```
39+
```console
4040
$ banyan
4141
usage: banyan [options] <command> <subcommand> [<subcommand> ...] [parameters]
4242

@@ -71,7 +71,7 @@ Commands:
7171

7272
Each of the commands has multiple subcommands. For example, `banyan service` allows you to list services, create/delete, enable/disable, etc. Run the command without any subcommand to see the options:
7373

74-
```
74+
```console
7575
$ banyan service
7676
usage: banyan service [-h]
7777
{attach-policy,create,delete,detach-policy,disable,enable,get,list,test,update}
@@ -96,7 +96,7 @@ sub-commands:
9696

9797
To see the full help available for any command, just add the `-h` or `--help` option to the end of the command. For example:
9898

99-
```
99+
```console
100100
$ banyan service attach-policy --help
101101
usage: banyan service attach-policy [-h] [--permissive] [--enforcing]
102102
service_name_or_id policy_name_or_id
@@ -121,7 +121,7 @@ This project includes a number of helpers in the `Makefile` to streamline common
121121

122122
The easiest way to work on the code is to create a local `virtualenv`. The included Makefile will do that for you:
123123

124-
```
124+
```console
125125
$ make virtualenv
126126
$ source env/bin/activate
127127
```
@@ -130,7 +130,7 @@ $ source env/bin/activate
130130

131131
Place unit tests in the `tests/` folder and run them with `make test` or `pytest`:
132132

133-
```
133+
```console
134134
$ pytest tests/
135135
```
136136

@@ -139,7 +139,7 @@ $ pytest tests/
139139

140140
Before releasing to PyPi, you must configure your login credentials in `~/.pypirc`:
141141

142-
```
142+
```ini
143143
[pypi]
144144
username = YOUR_USERNAME
145145
password = YOUR_PASSWORD
@@ -152,7 +152,7 @@ password = YOUR_OTHER_PASSWORD
152152

153153
Then use the `Makefile` to upload to pypi.org or test.pypi.org:
154154

155-
```
155+
```console
156156
$ make test-upload
157157
$ make dist-upload
158158
```
@@ -164,7 +164,7 @@ $ make dist-upload
164164
Included is a basic `Dockerfile` for building and distributing `Banyan CLI`,
165165
and can be built with the included `make` helper:
166166

167-
```
167+
```console
168168
$ make docker
169169
$ docker run -it banyan --help
170170
```

0 commit comments

Comments
 (0)