Skip to content

Commit d559922

Browse files
authored
Merge pull request #1016 from mozilla/ajvb/ci-badge
README and author tweaks
2 parents e926348 + d6bc216 commit d559922

2 files changed

Lines changed: 13 additions & 37 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ else
8282
cp $$GOPATH/bin/sops tmppkg/usr/local/bin/
8383
fpm -C tmppkg -n sops --license MPL2.0 --vendor mozilla \
8484
--description "Sops is an editor of encrypted files that supports YAML, JSON and BINARY formats and encrypts with AWS KMS and PGP." \
85-
-m "Julien Vehent <jvehent+sops@mozilla.com>" \
85+
-m "Mozilla Security <security@mozilla.org>" \
8686
--url https://go.mozilla.org/sops \
8787
--architecture x86_64 \
8888
-v "$$(grep '^const Version' version/version.go |cut -d \" -f 2)" \

README.rst

Lines changed: 12 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,8 @@ formats and encrypts with AWS KMS, GCP KMS, Azure Key Vault, age, and PGP.
99

1010
------------
1111

12-
.. image:: https://godoc.org/go.mozilla.org/sops?status.svg
13-
:target: https://godoc.org/go.mozilla.org/sops
14-
15-
.. image:: https://travis-ci.org/mozilla/sops.svg?branch=master
16-
:target: https://travis-ci.org/mozilla/sops
12+
.. image:: https://pkg.go.dev/badge/go.mozilla.org/sops/v3.svg
13+
:target: https://pkg.go.dev/go.mozilla.org/sops/v3
1714

1815
Download
1916
--------
@@ -28,12 +25,13 @@ For the adventurous, unstable features are available in the `develop` branch, wh
2825

2926
.. code:: bash
3027
31-
$ go get -u go.mozilla.org/sops/v3/cmd/sops
28+
$ mkdir -p $GOPATH/src/go.mozilla.org/sops/
29+
$ git clone https://github.com/mozilla/sops.git $GOPATH/src/go.mozilla.org/sops/
3230
$ cd $GOPATH/src/go.mozilla.org/sops/
3331
$ git checkout develop
3432
$ make install
3533
36-
(requires Go >= 1.13)
34+
(requires Go >= 1.17)
3735

3836
If you don't have Go installed, set it up with:
3937

@@ -46,12 +44,7 @@ If you don't have Go installed, set it up with:
4644
4745
Or whatever variation of the above fits your system and shell.
4846

49-
To use **sops** as a library, take a look at the `decrypt package <https://godoc.org/go.mozilla.org/sops/decrypt>`_.
50-
51-
**What happened to Python Sops?** We rewrote Sops in Go to solve a number of
52-
deployment issues, but the Python branch still exists under ``python-sops``. We
53-
will keep maintaining it for a while, and you can still ``pip install sops``,
54-
but we strongly recommend you use the Go version instead.
47+
To use **sops** as a library, take a look at the `decrypt package <https://pkg.go.dev/go.mozilla.org/sops/v3/decrypt>`_.
5548

5649
.. sectnum::
5750
.. contents:: Table of Contents
@@ -1370,26 +1363,6 @@ The value must be formatted as json.
13701363
13711364
$ sops --set '["an_array"][1] {"uid1":null,"uid2":1000,"uid3":["bob"]}' ~/git/svc/sops/example.yaml
13721365
1373-
Using sops as a library in a python script
1374-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1375-
1376-
You can import sops as a module and use it in your python program.
1377-
1378-
.. code:: python
1379-
1380-
import sops
1381-
1382-
pathtype = sops.detect_filetype(path)
1383-
tree = sops.load_file_into_tree(path, pathtype)
1384-
sops_key, tree = sops.get_key(tree)
1385-
tree = sops.walk_and_decrypt(tree, sops_key)
1386-
sops.write_file(tree, path=path, filetype=pathtype)
1387-
1388-
Note: this uses the previous implementation of `sops` written in python,
1389-
1390-
and so doesn't support newer features such as GCP-KMS.
1391-
To use the current version, call out to ``sops`` using ``subprocess.run``
1392-
13931366
Showing diffs in cleartext in git
13941367
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13951368
@@ -1705,8 +1678,8 @@ file format introduced in **1.0**.
17051678
Security
17061679
--------
17071680
1708-
Please report security issues to jvehent at mozilla dot com, or by using one
1709-
of the contact method available on keybase: `https://keybase.io/jvehent <https://keybase.io/jvehent>`_
1681+
Please report security issues to security at mozilla dot org, or by using one
1682+
of the contact method available here: `https://www.mozilla.org/en-US/security/#For_Developers <https://www.mozilla.org/en-US/security/#For_Developers>`_
17101683
17111684
License
17121685
-------
@@ -1717,9 +1690,12 @@ Authors
17171690
17181691
The core team is composed of:
17191692
1693+
* AJ Banhken @ajvb
1694+
1695+
The original authors were:
1696+
17201697
* Adrian Utrilla @autrilla
17211698
* Julien Vehent @jvehent
1722-
* AJ Banhken @ajvb
17231699
17241700
And a whole bunch of `contributors <https://github.com/mozilla/sops/graphs/contributors>`_
17251701

0 commit comments

Comments
 (0)