@@ -7,16 +7,22 @@ GpgEdit uses GnuPG to encrypt your secrets into a simple gpg file.
7
7
8
8
You can install from PyPI:
9
9
10
- pip install gpgedit
10
+ ``` console
11
+ $ pip install gpgedit
12
+ ```
11
13
12
14
Or from zip URL:
13
15
14
- pip install https://github.com/bachew/gpgedit/archive/master.zip
16
+ ``` console
17
+ pip install https://github.com/bachew/gpgedit/archive/master.zip
18
+ ```
15
19
16
20
Or install from cloned repo:
17
21
18
- git clone https://github.com/bachew/gpgedit.git
19
- pip install gpgedit
22
+ ``` consle
23
+ git clone https://github.com/bachew/gpgedit.git
24
+ pip install gpgedit
25
+ ```
20
26
21
27
22
28
## Usage
@@ -61,46 +67,45 @@ Notice the output is verbose and there's no way to turn it off so that you see h
61
67
62
68
## Development
63
69
64
- To setup development environment, clone the repo, run bootstrap and activate virtual environment:
70
+ To setup development environment, clone the repo, run init.py and activate virtual environment:
65
71
66
- $ ./bootstrap
67
- $ source gpgedit-py3*/bin/activate
68
- $ gpgedit -h
69
-
70
- To test on Python 2.7:
71
-
72
- $ cat > bootstrap_config_test.py
73
- python = 'python2'
74
- venv_dir = 'gpgedit-py2.7'
75
- $ ./bootstrap
76
- $ source gpgedit-py2.7/bin/activate
77
- $ gpgedit -h
72
+ ``` console
73
+ $ python3 init.py
74
+ $ pipenv shell
75
+ $ gpgedit -h
76
+ ```
78
77
79
78
` tmp ` is listed in ` .gitignore ` , create it for use in testing:
80
79
81
- $ mkdir tmp
80
+ ``` console
81
+ $ mkdir tmp
82
+ ```
82
83
83
84
Run ` tox ` to run unit tests on Python 2.7 and 3.
84
85
85
86
Lastly, some manual tests:
86
87
87
- # Create new gpg file
88
- $ gpgedit tmp/x.gpg
88
+ ``` console
89
+ # Create new gpg file
90
+ $ gpgedit tmp/x.gpg
89
91
90
- # Create new gpg file without changes
91
- $ gpgedit tmp/y.gpg
92
+ # Create new gpg file without changes
93
+ $ gpgedit tmp/y.gpg
92
94
93
- # Edit existing gpg file
94
- $ gpgedit tmp/x.gpg
95
+ # Edit existing gpg file
96
+ $ gpgedit tmp/x.gpg
95
97
96
- # Edit but without changes
97
- $ gpgedit tmp/x.gpg
98
+ # Edit but without changes
99
+ $ gpgedit tmp/x.gpg
100
+ ```
98
101
99
102
100
103
### Release
101
104
102
105
Before releasing, make sure ` README.md ` is up-to-date. If you updated it, please preview it before committing:
103
106
104
- $ markdown_py README.md -f tmp/README.html
107
+ ``` console
108
+ $ markdown_py README.md -f tmp/README.html
109
+ ```
105
110
106
111
Increase ` setup.py::config['version'] ` , commit and merge to master branch. Travis will build and deploy to [ PyPI] ( https://pypi.python.org ) .
0 commit comments