Skip to content
Permalink
Browse files

Update fork (#1)

* Release v0.7.2 (hvac#371)

* Tweak Travis CI Configuration (hvac#360)

* drop sudo: false

* remove explicit dist

* simplify build matrix

* change flake8 toxenv name to avoid matching tox-travis default prefixes

* Remove unnecessary `export PATH` "script" step

* Simplify env from list to k/v string

* Clarifying comment re: flake8

* Simplify "allowed failures" row matching

* Speed up overall build time with fast_finish: true

* Rearrange comment to same line being commented on

* Include python 3.7 build jobs

* Bump 0.11 and 1.0 Vault vers to latest patch ver

* Also run flake8 for python 3.7

* Also include "py37" on the tox side of things

* Keep "dist: xenial" for python 3.7 availability

* Tweak flake8 job names for readability

* Shorten comment

* Backporting Master (hvac#362)

* fix double slash (hvac#352)

When called, double slash results in 301 HTTP code and the redirect which is necessary

* Release v0.7.1 (hvac#357)

* Develop is the new integration branch

* Handle "Misses" for Identity Secrets Lookups (hvac#331)

* Regression tests for group lookup misses

* Return None for group lookup misses

* Regression tests for entity lookup misses

* Return None for entity lookup misses

* Also update docstrings

* Move Test Cases out of Package Directory (hvac#334)

* use utils function to get test data path

* rename test => tests and move contents into config_files subdir

* Move scripts subdir under tests dir in root

* Move generate.sh into scripts subdir

* Update paths in generate_test_cert.sh

* clean up config_files readme a smidge

* move test dir into repo root dir

* update import paths

* start breaking out test utils into module

* Break out mock_github_request_handler

* Break out hvac_integration_test_case

* Break out server_manager

* Remove .coveragerc until / unless it is needed once again

* Add Okta Auth Method Class (hvac#341)

* Rename auth subdir under unit_tests

* bonus GCP docs heading fix

* Add Okta auth method docs

* Add Okta auth method test cases

* Add Okta auth method class implementation

* Add pretty_print arg to create_or_update_policy (hvac#342)

* Add pretty_print arg

* Skip new test on Vault v0.11.0

* Bump Vault Versions - Vault v1.0.0 (hvac#344)

* fix TOXENV for 3.6 jobs

* Drop v0.8.3, add v1.0.0

* Update readme

* Handle different response keys in Vault v1.0.0

* Also work around new list response return type

* Add get_generate_root_otp utils method for v1.0.0 and/or previous vers

* Update missed TOXENV arg under allow_failures dict

* Call out why v0.11.0 is hanging about

* Clarify name/purpose of vault ver comparison methods

* Fix identity group conditionals (hvac#346)

* Add regression tests

* Fix member entity/group ids logic in group methods

* DRY up conditional logic

* Add missing docstring content

* Gcp login doc update for issue 345 (hvac#350)

* Clarify source links

* add google-api-python-client example

* Clean up unintentional modification

* Fix For read_health_status() Exception Handling (hvac#347)

* Add url param for create_client

* Install consul for test cases involving Vault HA

* Update test harness with optional Vault HA / consul set up

* Add regerssion test cases for issue hvac#339

* Add raise_exception param to requests

* Use raise_exception param in read_health_status method

* Add ipaddress module per github.com/urllib3/urllib3/issues/1117?

Somehow ended up with this urllib3 error for python 2.7 otherwise:
"urllib3.connection: ERROR: Certificate did not match expected hostname:
127.0.0.1. Certificate: {'serialNumber': u'8D267F50728FF454',
'subject': ((('commonName', u'localhost'),),),
'notAfter': 'May 14 22:44:13 2025 GMT',
'notBefore': u'May 17 22:44:13 2015 GMT',
'subjectAltName': (('DNS', 'localhost'), ('IP Address', '127.0.0.1')),
'issuer': ((('commonName', u'localhost'),),), 'version': 3L}

* Clarify docstring a bit

* Also add cases to cover both HEAD and GET methods

* Remove standby node magic strings; use method instead

* Fix seal_status Call (hvac#354)

* Add regression tests

* Fix seal_status call

* More meaningful assertion

* Fix Request Redirection Handling (hvac#348)

* simplify chained comparison

* Ensure regression unit test case coverage for paths/redirects

* Revert redirection handling back to the requests module

* Handle double slashes in paths

* Fix syntax for python 2.7

* Log when we transform a requested url

* Explictly assert that we have the expect requests in mocker history

* Clarify lease docs (hvac#355)

* Updates for upcoming release 0.7.1

* Bump patch version to 0.7.1

* prune tests from packages (hvac#356)

* Wait for test kvv2 secrets engine to show up in list (hvac#361)

* Set "skip_missing_interpreters" to true in global tox config (hvac#363)

* Set "skip_missing_interpreters" to true in global tox config

* go full env string expansion 😝 cause why not

* Fix For Intermittent Health Test Case Failure (hvac#364)

* Ensure we get an active node when needed

* Remove unneeded debug call

* Simplify flake8 env for travis-ci + tox (hvac#365)

* Simplify flake8 env for travis-ci + tox

* Add missing comma

* Test Documentation Compilation (hvac#366)

* Update docs requirements to be more explicit

* Test that docs can build cleanly

* Fix m2r requirement

* Clearer job name

* Default to first python ver in the matrix...

* Further clarify job name

* Reorder tox directives a smidge...

* Cleanup setup.py a bit (hvac#367)

* Update author / author_email

* Move some auxiliary logic into methods

* gmai.com -> gmail.com

* reorder author names

* Use pip-compile For All Requirements (hvac#368)

* Add section covering requirement updates

* Add .in req files, breakout parser (pyhcl) extra_require

* pip-compile all the things

* Pull in latest reqs for docs for good measure

* Add update-all-reqs Makefile targets

* Define "parser" requirements in just one place

* Add clarifying comment

* Simplify new Makefile targets a smidge

* comment bout comments

* Makefile clarifying comment

* Use abs paths starting from setup.py location

* Also dynamically populate install_requires

* Revert requirements loading in setup.py; tis a silly thing to do

* Bump install_requires / extras_require min versions

* Drop extra "parser" requirements as its not strictly needed

* Drop use of "version" file (hvac#369)

* Drop use of "version" file

* Clarify updated bumpversion release step

* Fix grammerz

* Remove inadvertently committed hvac/version file

* Organize imports

* Add AWS Secrets Engine Class (hvac#370)

* auto generated script

* Include Docs

* "Implement" Aws class

* Tweak docstrings and whatnot

* Param tweaks

* update convert ttl for aws secrets return values

* First pass on aws secrets engine tests

* Fix headings

* Cleanup unused mock server logic, additional role params

* Accept policy_document dict param type

* Start filling in aws secrets docs

* E501 line too long (162 > 160 characters)

* First pass at handling legacy params

* Different status code from Vault v0.11.0 :\

* Fill in legacy_params-related comments / docstrings

* Also update docs

* Add contents section and upper case heading

* Adding a Twitter Badge (hvac#372)

* Split up icons with linebreaks

* Add Twitter badge for @hvac_python

* Adding Header image (hvac#373)

* Add header image

* Update twitter handle

* Update content email and test URLs

* Commit header image

* Update header image URL to final resting place

* Changelog updates for v0.7.2 release

* Update release steps

* Update copyright date

* Bump version: 0.7.1 → 0.7.2

* Clean up vestigial version target reference

* Add Kubernetes Auth Method (hvac#408)

* Release v0.7.2 (hvac#371)

* Tweak Travis CI Configuration (hvac#360)

* drop sudo: false

* remove explicit dist

* simplify build matrix

* change flake8 toxenv name to avoid matching tox-travis default prefixes

* Remove unnecessary `export PATH` "script" step

* Simplify env from list to k/v string

* Clarifying comment re: flake8

* Simplify "allowed failures" row matching

* Speed up overall build time with fast_finish: true

* Rearrange comment to same line being commented on

* Include python 3.7 build jobs

* Bump 0.11 and 1.0 Vault vers to latest patch ver

* Also run flake8 for python 3.7

* Also include "py37" on the tox side of things

* Keep "dist: xenial" for python 3.7 availability

* Tweak flake8 job names for readability

* Shorten comment

* Backporting Master (hvac#362)

* fix double slash (hvac#352)

When called, double slash results in 301 HTTP code and the redirect which is necessary

* Release v0.7.1 (hvac#357)

* Develop is the new integration branch

* Handle "Misses" for Identity Secrets Lookups (hvac#331)

* Regression tests for group lookup misses

* Return None for group lookup misses

* Regression tests for entity lookup misses

* Return None for entity lookup misses

* Also update docstrings

* Move Test Cases out of Package Directory (hvac#334)

* use utils function to get test data path

* rename test => tests and move contents into config_files subdir

* Move scripts subdir under tests dir in root

* Move generate.sh into scripts subdir

* Update paths in generate_test_cert.sh

* clean up config_files readme a smidge

* move test dir into repo root dir

* update import paths

* start breaking out test utils into module

* Break out mock_github_request_handler

* Break out hvac_integration_test_case

* Break out server_manager

* Remove .coveragerc until / unless it is needed once again

* Add Okta Auth Method Class (hvac#341)

* Rename auth subdir under unit_tests

* bonus GCP docs heading fix

* Add Okta auth method docs

* Add Okta auth method test cases

* Add Okta auth method class implementation

* Add pretty_print arg to create_or_update_policy (hvac#342)

* Add pretty_print arg

* Skip new test on Vault v0.11.0

* Bump Vault Versions - Vault v1.0.0 (hvac#344)

* fix TOXENV for 3.6 jobs

* Drop v0.8.3, add v1.0.0

* Update readme

* Handle different response keys in Vault v1.0.0

* Also work around new list response return type

* Add get_generate_root_otp utils method for v1.0.0 and/or previous vers

* Update missed TOXENV arg under allow_failures dict

* Call out why v0.11.0 is hanging about

* Clarify name/purpose of vault ver comparison methods

* Fix identity group conditionals (hvac#346)

* Add regression tests

* Fix member entity/group ids logic in group methods

* DRY up conditional logic

* Add missing docstring content

* Gcp login doc update for issue 345 (hvac#350)

* Clarify source links

* add google-api-python-client example

* Clean up unintentional modification

* Fix For read_health_status() Exception Handling (hvac#347)

* Add url param for create_client

* Install consul for test cases involving Vault HA

* Update test harness with optional Vault HA / consul set up

* Add regerssion test cases for issue hvac#339

* Add raise_exception param to requests

* Use raise_exception param in read_health_status method

* Add ipaddress module per github.com/urllib3/urllib3/issues/1117?

Somehow ended up with this urllib3 error for python 2.7 otherwise:
"urllib3.connection: ERROR: Certificate did not match expected hostname:
127.0.0.1. Certificate: {'serialNumber': u'8D267F50728FF454',
'subject': ((('commonName', u'localhost'),),),
'notAfter': 'May 14 22:44:13 2025 GMT',
'notBefore': u'May 17 22:44:13 2015 GMT',
'subjectAltName': (('DNS', 'localhost'), ('IP Address', '127.0.0.1')),
'issuer': ((('commonName', u'localhost'),),), 'version': 3L}

* Clarify docstring a bit

* Also add cases to cover both HEAD and GET methods

* Remove standby node magic strings; use method instead

* Fix seal_status Call (hvac#354)

* Add regression tests

* Fix seal_status call

* More meaningful assertion

* Fix Request Redirection Handling (hvac#348)

* simplify chained comparison

* Ensure regression unit test case coverage for paths/redirects

* Revert redirection handling back to the requests module

* Handle double slashes in paths

* Fix syntax for python 2.7

* Log when we transform a requested url

* Explictly assert that we have the expect requests in mocker history

* Clarify lease docs (hvac#355)

* Updates for upcoming release 0.7.1

* Bump patch version to 0.7.1

* prune tests from packages (hvac#356)

* Wait for test kvv2 secrets engine to show up in list (hvac#361)

* Set "skip_missing_interpreters" to true in global tox config (hvac#363)

* Set "skip_missing_interpreters" to true in global tox config

* go full env string expansion 😝 cause why not

* Fix For Intermittent Health Test Case Failure (hvac#364)

* Ensure we get an active node when needed

* Remove unneeded debug call

* Simplify flake8 env for travis-ci + tox (hvac#365)

* Simplify flake8 env for travis-ci + tox

* Add missing comma

* Test Documentation Compilation (hvac#366)

* Update docs requirements to be more explicit

* Test that docs can build cleanly

* Fix m2r requirement

* Clearer job name

* Default to first python ver in the matrix...

* Further clarify job name

* Reorder tox directives a smidge...

* Cleanup setup.py a bit (hvac#367)

* Update author / author_email

* Move some auxiliary logic into methods

* gmai.com -> gmail.com

* reorder author names

* Use pip-compile For All Requirements (hvac#368)

* Add section covering requirement updates

* Add .in req files, breakout parser (pyhcl) extra_require

* pip-compile all the things

* Pull in latest reqs for docs for good measure

* Add update-all-reqs Makefile targets

* Define "parser" requirements in just one place

* Add clarifying comment

* Simplify new Makefile targets a smidge

* comment bout comments

* Makefile clarifying comment

* Use abs paths starting from setup.py location

* Also dynamically populate install_requires

* Revert requirements loading in setup.py; tis a silly thing to do

* Bump install_requires / extras_require min versions

* Drop extra "parser" requirements as its not strictly needed

* Drop use of "version" file (hvac#369)

* Drop use of "version" file

* Clarify updated bumpversion release step

* Fix grammerz

* Remove inadvertently committed hvac/version file

* Organize imports

* Add AWS Secrets Engine Class (hvac#370)

* auto generated script

* Include Docs

* "Implement" Aws class

* Tweak docstrings and whatnot

* Param tweaks

* update convert ttl for aws secrets return values

* First pass on aws secrets engine tests

* Fix headings

* Cleanup unused mock server logic, additional role params

* Accept policy_document dict param type

* Start filling in aws secrets docs

* E501 line too long (162 > 160 characters)

* First pass at handling legacy params

* Different status code from Vault v0.11.0 :\

* Fill in legacy_params-related comments / docstrings

* Also update docs

* Add contents section and upper case heading

* Adding a Twitter Badge (hvac#372)

* Split up icons with linebreaks

* Add Twitter badge for @hvac_python

* Adding Header image (hvac#373)

* Add header image

* Update twitter handle

* Update content email and test URLs

* Commit header image

* Update header image URL to final resting place

* Changelog updates for v0.7.2 release

* Update release steps

* Update copyright date

* Bump version: 0.7.1 → 0.7.2

* Clean up vestigial version target reference

* add auth method for Kubernetes

* add tests for Kubernetes auth method

* add function  for check certificate PEM format

* update project common files

* change dict multiline to oneline

* fix gcp integration tests with bound_service_accounts

* Add support for setting VAULT_ADDR and VAULT_TOKEN via env vars (hvac#411)

* Fix delete_role_secret_id_accessor method (hvac#375)

* Fix delete_role_secret_id_accessor method

* Fix unit test as well

* hvac#376 : fix length in transit.generate_random_bytes() (hvac#377)

The parameter in the HTTP request was incorrect according to the
latest vault API
https://www.vaultproject.io/api/secret/transit/index.html

* Update Test Runs With Latest Vault Versions (1.0.3 & 1.1.0) (hvac#396)

* test with the latest vault 1.0.X (1.0.3)

* Add in 1.1.0, drop 0.9.6

* Explictly enable kv v1 secrets engine

* Ensure kv v1 secrets engine under /secret for legacy test cases

* Explictly enable kv v1 secrets engine for sys test classes

* fix indentation

* -Fixed AWS sts generation to use POST rather than GET. (hvac#392)

* Add possibility to specify type in create_token (hvac#393)

* Add possibility to specify type in create_token

All errors related to explicit_max_ttl / root batch token / ... will get thrown by server

* Fix E303/W293 flake8 complaints

* Add initial retrieve_mount_option method

* Fix recovery_threshold / recovery_shares conditional

* fix docstring typo

* Fix allowed kv versions logic

* Tweak server manager logic a bit

* Add doctest for getting started bits

* Add missing colon in docstring

* Fix getting-started link

* Drop stray comments

* Ensure kv engine enabled for v1.1.0 doctests

* Bump requested go version so we can build Vault HEAD ref (hvac#412)

* Fix formatting

* drop stray character / typo

* Do no run doctest during readthedocs builds

* Changelog updates for v0.8.0 release

* Bump version: 0.7.2 → 0.8.0

* Drop RST markup that made it into the readme

* Hacky workaround / fork of doctest for RTD builds

* Drop remaining HVAC_RENDER_DOCTESTS references

* Clarify some wording

* Ignore forked sphinx ext for the purposes of flake8 for now

* Revert "Fix recovery_threshold / recovery_shares conditional"

This reverts commit e363738.

* Changelog updates for v0.8.1 release

* Bump version: 0.8.0 → 0.8.1

* Actually do not install tests

In hvac#294 `tests` directory was moved out from `hvac` with the intention to not
install tests into site-packages. However, find_packages() still finds and
installs it, this time as a top-level package. Pass it into exclude to really
skip it.

Same thing for `docs`.

* Fix precedence of `VAULT_ADDR` environment variable vs client `url` parameter

Fixes hvac#421.

The vault CLI priorities the `-address` flag over the `VAULT_ADDR`
environment variable. This commit aligns hvac to that behaviour.

* Move client default url value to client constants

* Changelog updates for v0.8.2 release

* Bump version: 0.8.1 → 0.8.2
  • Loading branch information...
jsporna committed Apr 4, 2019
1 parent 150ad20 commit 3dd9f3eb42ef5a589d3105baf74d84810f49f83b
Showing with 1,943 additions and 186 deletions.
  1. +1 −1 .bumpversion.cfg
  2. +4 −0 .gitignore
  3. +2 −2 .travis.yml
  4. +33 −0 CHANGELOG.md
  5. +14 −47 README.md
  6. 0 docs/__init__.py
  7. +36 −4 docs/conf.py
  8. 0 docs/ext/__init__.py
  9. +597 −0 docs/ext/doctest.py
  10. +5 −9 docs/index.rst
  11. +232 −0 docs/overview.rst
  12. +0 −1 docs/readme.rst
  13. +3 −1 hvac/api/auth_methods/__init__.py
  14. +245 −0 hvac/api/auth_methods/kubernetes.py
  15. +11 −4 hvac/api/secrets_engines/aws.py
  16. +2 −2 hvac/api/secrets_engines/kv.py
  17. +1 −1 hvac/api/secrets_engines/transit.py
  18. +15 −1 hvac/api/system_backend/mount.py
  19. +2 −2 hvac/api/system_backend/seal.py
  20. +2 −0 hvac/constants/client.py
  21. +65 −1 hvac/utils.py
  22. +16 −6 hvac/v1/__init__.py
  23. +2 −2 setup.py
  24. +12 −0 tests/config_files/vault-doctest.hcl
  25. +69 −0 tests/doctest/__init__.py
  26. +4 −15 tests/integration_tests/api/auth_methods/test_gcp.py
  27. +297 −0 tests/integration_tests/api/auth_methods/test_kubernetes.py
  28. +22 −74 tests/integration_tests/api/auth_methods/test_ldap.py
  29. +24 −0 tests/integration_tests/api/secrets_engines/test_kv_v1.py
  30. +14 −1 tests/integration_tests/api/system_backend/test_mount.py
  31. +9 −0 tests/integration_tests/v1/test_integration.py
  32. +16 −1 tests/integration_tests/v1/test_system_backend.py
  33. +1 −1 tests/scripts/install-vault.sh
  34. +74 −0 tests/unit_tests/api/auth_methods/test_kubernetes.py
  35. +2 −3 tests/unit_tests/v1/test_approle_routes.py
  36. +75 −0 tests/utils/mock_ldap_server.py
  37. +13 −4 tests/utils/server_manager.py
  38. +23 −3 tox.ini
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.7.2
current_version = 0.8.2
commit = True
tag = True

@@ -13,3 +13,7 @@ test/*.log

# sphinx build folder
docs/_build/

.idea/
venv/
.envrc
@@ -5,11 +5,11 @@ python:
- '3.6'
- '3.7'
env:
- HVAC_VAULT_VERSION=0.9.6
- HVAC_VAULT_VERSION=0.10.4
- HVAC_VAULT_VERSION=0.11.0 # This ver kept explicitly; it has subsequently reverted backwards-incompatible changes.
- HVAC_VAULT_VERSION=0.11.6
- HVAC_VAULT_VERSION=1.0.1
- HVAC_VAULT_VERSION=1.0.3
- HVAC_VAULT_VERSION=1.1.0
- HVAC_VAULT_VERSION=HEAD
- TOXENV=flake8
matrix:
@@ -1,5 +1,38 @@
# Changelog

## 0.8.2 (April 4th, 2019)

BUG FIXES:

* Fix priority of client url and VAULT_ADDR environment variable. [GH-423](https://github.com/hvac/hvac/pull/423)
* Update setup.py to only compile hvac package. [GH-418](https://github.com/hvac/hvac/pull/418)

Thanks to @eltoder and @andytumelty for their lovely contributions.

## 0.8.1 (March 31st, 2019)

BUG FIXES:

* Fix `initialize()` method `recovery_shares` and `recovery_threshold` parameter validation regression. [GH-416](https://github.com/hvac/hvac/pull/416)

## 0.8.0 (March 29th, 2019)

BACKWARDS COMPATIBILITY NOTICE:

* The `Client()` class constructor now behaves similarly to Vault CLI in that it uses the `VAULT_ADDR` environmental variable for the Client URL when that variable is set. Along the same lines, when no token is passed into the `Client()` constructor, it will attempt to load a token from the `VAULT_TOKEN` environmental variable or the `~/.vault-token` file where available. [GH-411](https://github.com/hvac/hvac/pull/411)

IMPROVEMENTS:

* Support for the Kubernetes auth method. [GH-408](https://github.com/hvac/hvac/pull/408)

BUG FIXES:

* Fix for comparision `recovery_threshold` and `recovery_shares` during initialization. [GH-398](https://github.com/hvac/hvac/pull/398)
* Fix request method for AWS secrets engine `generate_credentials()` method. [GH-403](https://github.com/hvac/hvac/pull/403)
* Fix request parameter (`n_bytes` -> `bytes`) for Transit secrets engine `generate_random_bytes()` method. [GH-377](https://github.com/hvac/hvac/pull/377)

Thanks to @engstrom, @viralpoetry, @bootswithdefer, @steved, @kserrano, @spbsoluble, @uepoch, @singuliere, @frgaudet, @jsporna, & @mrsiesta for their lovely contributions.

## 0.7.2 (January 1st, 2019)

IMPROVEMENTS:
@@ -11,62 +11,29 @@
[![Twitter - @python_hvac](https://img.shields.io/twitter/follow/python_hvac.svg?label=Twitter%20-%20@python_hvac&style=social?style=plastic)](https://twitter.com/python_hvac)

Tested against the latest release, HEAD ref, and 3 previous major versions (counting back from the latest release) of Vault.
Currently supports Vault v0.9.6 or later.
Currently supports Vault v0.10.4 or later.

## Documentation

Documentation for this module is hosted on [readthedocs.io](https://hvac.readthedocs.io/en/latest/).

## Getting started
## Installation

### Installation

```bash
```console
pip install hvac
```
or
```bash
pip install "hvac[parser]"
```
if you would like to be able to return parsed HCL data as a Python dict for methods that support it.

### Initialize the client

```python
import os
import hvac

# Using plaintext
client = hvac.Client()
client = hvac.Client(url='http://localhost:8200')
client = hvac.Client(url='http://localhost:8200', token=os.environ['VAULT_TOKEN'])
# Using TLS
client = hvac.Client(url='https://localhost:8200')
# Using TLS with client-side certificate authentication
client = hvac.Client(url='https://localhost:8200', cert=('path/to/cert.pem', 'path/to/key.pem'))
# Using Namespace
client = hvac.Client(url='http://localhost:8200', token=os.environ['VAULT_TOKEN'], namespace=os.environ['VAULT_NAMESPACE'])
If you would like to be able to return parsed HCL data as a Python dict for methods that support it:

```console
pip install "hvac[parser]"
```

### Read and write to secret backends

```python
client.write('secret/foo', baz='bar', lease='1h')

print(client.read('secret/foo'))
client.delete('secret/foo')
```
## Documentation

### Authenticate using token auth backend
Additional documentation for this module available at: [hvac.readthedocs.io](https://hvac.readthedocs.io/en/stable/usage/index.html):

```python
# Token
client.token = 'MY_TOKEN'
assert client.is_authenticated() # => True
```
* [Getting Started](https://hvac.readthedocs.io/en/stable/overview.html#getting-started)
* [Usage](https://hvac.readthedocs.io/en/stable/usage/index.html)
* [Advanced Usage](https://hvac.readthedocs.io/en/stable/advanced_usage.html)
* [Source Reference / Autodoc](https://hvac.readthedocs.io/en/stable/source/index.html)
* [Contributing](https://hvac.readthedocs.io/en/stable/contributing.html)
* [Changelog](https://hvac.readthedocs.io/en/stable/changelog.html)
No changes.
@@ -16,16 +16,16 @@
author = u'Ian Unruh, Jeffrey Hogan'

# The short X.Y version
version = '0.7.2'
version = '0.8.2'
# The full version, including alpha/beta/rc tags
release = '0.7.2'
release = '0.8.2'


# -- General configuration ---------------------------------------------------

extensions = [
'docs.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
@@ -49,7 +49,11 @@

html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']

html_context = {'no_skippy': True}
html_theme_options = {
# Toc options
'collapse_navigation': False,
}

# -- Options for HTMLHelp output ---------------------------------------------

@@ -67,6 +71,34 @@
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']

# -- doctest configuration -------------------------------------------------
if os.getenv('READ_THE_DOCS_BUILD') is not None:
doctest_global_enabled = False

doctest_global_setup = '''
import os
from pprint import pprint, pformat
import mock
import hvac
from tests import utils as test_utils
from tests.doctest import doctest_global_setup
from tests.utils.server_manager import ServerManager
client_cert_path = test_utils.get_config_file_path('client-cert.pem')
client_key_path = test_utils.get_config_file_path('client-key.pem')
server_cert_path = test_utils.get_config_file_path('server-cert.pem')
manager = doctest_global_setup()
client = manager.client
'''

doctest_global_cleanup = '''
# mocker.stop()
manager.stop()
'''

# -- Autodoc configuration -------------------------------------------------


No changes.

0 comments on commit 3dd9f3e

Please sign in to comment.
You can’t perform that action at this time.