Commit graph

3213 commits

Author SHA1 Message Date
Vladimir Diaz
56aa91239b
Use guard clause and comment on expected exceptions raised by try block
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-28 11:34:59 -04:00
Vladimir Diaz
839c646204
Convert lists to sets, use == instead of membership operator, remove unneeded write()
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-28 11:02:36 -04:00
Vladimir Diaz
16071e0421
Use set() instead list() for supported key types, and revise comment
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 17:58:38 -04:00
Vladimir Diaz
609889fa24
Use guard clause and set a constant for the list of supported CLI key types
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 17:44:28 -04:00
Vladimir Diaz
5e94dd3f08
Use consistent number of blank lines between functions
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 17:28:47 -04:00
Vladimir Diaz
8a7e0fc4b0
Add constants for the keytypes specified on the command line
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 16:54:32 -04:00
Vladimir Diaz
52ed7a2a04
Add note about using multile options in invocation, and add TODO
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 16:06:10 -04:00
Vladimir Diaz
725d809c65
Rename process_arguments() and revise docstring, remove TODO, minor changes
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 15:42:03 -04:00
Vladimir Diaz
c19147e29d
Merge pull request #760 from vladimir-v-diaz/revise_CLI_EXAMPLES.md
Revise CLI_EXAMPLES.md
2018-06-27 14:56:01 -04:00
Vladimir Diaz
6bf8a95a71
Minor edits to relocate text and introduction
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 14:48:31 -04:00
Vladimir Diaz
3d88d8bde1
Remove obsolete text in the 'Clean' section of CLI.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 14:31:00 -04:00
Vladimir Diaz
d3c0852495
Outline the steps for the second example
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 14:30:16 -04:00
Vladimir Diaz
bccba83f96
Add introductory text, rename headings, change title
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 14:15:11 -04:00
Vladimir Diaz
c0224007e1
Merge branch 'develop' into revise_CLI_EXAMPLES.md 2018-06-27 13:50:23 -04:00
Vladimir Diaz
db7b9bd403
Include steps being follows and revise text in 'Replace a top-level key'
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 13:47:23 -04:00
Vladimir Diaz
58a00d6b8b
Add missing command to create key_x and key_x2
Add blank lines between commands to help readability

Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 13:33:19 -04:00
Vladimir Diaz
dceb6bcc9b
Rename the keys and metadata for role X and Y
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 13:22:31 -04:00
Vladimir Diaz
c8433b4834
Merge pull request #759 from vladimir-v-diaz/revise_CLI.md
Revise CLI.md to address reviewer comments
2018-06-27 11:48:50 -04:00
Vladimir Diaz
46a624f897
Revise 'clean' section, modify a couple headings, and minor tweaks to text
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 11:21:35 -04:00
Vladimir Diaz
b8bec7be7d
Relocate the --sign section, add line breaks, and minor revision to text
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-27 10:40:40 -04:00
Vladimir Diaz
a50256b1c0
Merge pull request #758 from vladimir-v-diaz/address_CLI_quickstart_review
Revise QUICKSTART.md to address reviewer's comments
2018-06-27 10:06:54 -04:00
Vladimir Diaz
473a0b0c12
Add a couple line breaks to help break apart the main text
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 17:21:07 -04:00
Vladimir Diaz
97021b4e16
Revise help description for --init
It should mention the files/directories that are created.

Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 17:20:33 -04:00
Vladimir Diaz
1c3d1ee302
Revise QUICKSTART.md to capture more of what happens in the background
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 17:07:33 -04:00
Vladimir Diaz
40289f0b55
Merge pull request #756 from vladimir-v-diaz/add_installation_note_quickstart
Add installation instructions to CLI.md and QUICKSTART.md
2018-06-26 13:32:21 -04:00
Vladimir Diaz
1133bb4ce4
Revise instructions in QUICKSTART.md to remove unnecessary info
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 13:26:38 -04:00
Vladimir Diaz
3f82734504
Revise instructions in CLI.md to remove typo and unnecessary info
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-26 13:25:50 -04:00
Vladimir Diaz
cb4b95137f
Add installation instructions to QUICKSTART.md for required dependencies
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-25 11:53:59 -04:00
Vladimir Diaz
f16784c67f
Add installation instructions to CLI.md for required dependencies
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-25 11:53:29 -04:00
Vladimir Diaz
b1abaf890a
Merge pull request #755 from vladimir-v-diaz/update_tutorial
Update TUTORIAL.md and behavior when importing/writing crypto keys
2018-06-21 15:53:28 -04:00
Vladimir Diaz
6ae7eb42ce
Revise text to cover new password behavior of securesystemslib
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-21 15:02:19 -04:00
Vladimir Diaz
4ee3537d6d
Prompt for password if one isn't given and the key file is encrypted
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-21 14:58:36 -04:00
Vladimir Diaz
1197ab9cf8
Make sure importing a private key follows the behavior covered in TUTORIAL.md
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-21 13:58:19 -04:00
Vladimir Diaz
fbc02d3034
Use a working example in the overview section
Some users will actually attempt to execute the example listed in the overview section.  Use a working example that doesn't raise an error.

Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-21 11:19:59 -04:00
Vladimir Diaz
965e121148
Update text covering the client update
* The client script is now named 'client.py' and the user is no longer required to manually copy the basic_client.py to the CWD
* A log file is not saved to the CWD, by default
* The client.py script doesn't download all target files available on the repo.

Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-21 11:07:16 -04:00
Vladimir Diaz
0e833cbab3
Merge pull request #754 from vladimir-v-diaz/render_markdown_pypi-issue#753
Set long description content type in setup.py.  Fix issue #753
2018-06-21 10:02:03 -04:00
Vladimir Diaz
9acab4b6bc
Add long_description_content_type to setup.py
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-20 17:52:34 -04:00
Vladimir Diaz
8152483f93
Include correct README in MANIFEST.in
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-20 17:50:41 -04:00
Vladimir Diaz
b74fc17afa
Merge pull request #752 from vladimir-v-diaz/add_v0.11.1_roadmap
Update ROADMAP.md
2018-06-20 11:20:25 -04:00
Vladimir Diaz
8873b4aca9
Add latest release (v0.11.1) and link to previous releases
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-20 11:04:21 -04:00
Vladimir Diaz
921e0f6d13
Merge pull request #751 from vladimir-v-diaz/release_v0.11.1
Bump release version to 0.11.1
2018-06-19 17:25:57 -04:00
Vladimir Diaz
48e0ecca5d
Add entry in CHANGELOG.md for v0.11.1
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-19 17:17:33 -04:00
Vladimir Diaz
4d07ce0287
Bump version number to 0.11.1 in setup.py
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-19 16:28:20 -04:00
Vladimir Diaz
b7872e1fe4
Merge pull request #749 from vladimir-v-diaz/file_handling-issue#748
Add functions for file logging.  Fix issue#748
2018-06-18 11:47:26 -04:00
Vladimir Diaz
996cce82ad
Make sure the default log file doesn't exist prior to test condition
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-18 10:42:09 -04:00
Vladimir Diaz
31f8f0566d
Add/revise entries in docstrings
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-18 10:41:05 -04:00
Vladimir Diaz
8a62facacd
Add test for disable_file_logging() in test_log.py
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-15 17:02:01 -04:00
Vladimir Diaz
c8621a785f
Add test condition for invalid arguments to enable_file_logging()
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-15 16:03:30 -04:00
Vladimir Diaz
75f95391a4
Verify the format of the log_filename argument to enable_file_logging()
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-15 16:03:03 -04:00
Vladimir Diaz
0c941fd340
Add test_enable_file_logging() in test_log.py
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-15 15:50:22 -04:00