1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
|
# ocspbuilder
A Python library for creating and signing online certificate status protocol
(OCSP) requests and responses for X.509 certificates.
- [Related Crypto Libraries](#related-crypto-libraries)
- [Current Release](#current-release)
- [Dependencies](#dependencies)
- [Installation](#installation)
- [License](#license)
- [Documentation](#documentation)
- [Continuous Integration](#continuous-integration)
- [Testing](#testing)
- [Development](#development)
## Related Crypto Libraries
*ocspbuilder* is part of the modularcrypto family of Python packages:
- [asn1crypto](https://github.com/wbond/asn1crypto)
- [oscrypto](https://github.com/wbond/oscrypto)
- [csrbuilder](https://github.com/wbond/csrbuilder)
- [certbuilder](https://github.com/wbond/certbuilder)
- [crlbuilder](https://github.com/wbond/crlbuilder)
- [ocspbuilder](https://github.com/wbond/ocspbuilder)
- [certvalidator](https://github.com/wbond/certvalidator)
## Current Release
0.10.2 - [changelog](changelog.md)
## Dependencies
- [*asn1crypto*](https://github.com/wbond/asn1crypto)
- [*oscrypto*](https://github.com/wbond/oscrypto)
- Python 2.6, 2.7, 3.2, 3.3, 3.4, 3.5 or pypy
## Installation
```bash
pip install ocspbuilder
```
## License
*ocspbuilder* is licensed under the terms of the MIT license. See the
[LICENSE](LICENSE) file for the exact license text.
## Documentation
[*ocspbuilder* documentation](docs/readme.md)
## Continuous Integration
- [Windows](https://ci.appveyor.com/project/wbond/ocspbuilder/history) via AppVeyor
- [OS X & Linux](https://travis-ci.org/wbond/ocspbuilder/builds) via Travis CI
## Testing
Tests are written using `unittest` and require no third-party packages:
```bash
python run.py tests
```
To run only some tests, pass a regular expression as a parameter to `tests`.
```bash
python run.py tests build
```
## Development
To install required development dependencies, execute:
```bash
pip install -r dev-requirements.txt
```
The following commands will run the linter and test coverage:
```bash
python run.py lint
python run.py coverage
```
The following will regenerate the API documentation:
```bash
python run.py api_docs
```
After creating a [semver](http://semver.org/) git tag, a `.tar.gz` and `.whl`
of the package can be created and uploaded to
[PyPi](https://pypi.python.org/pypi/ocspbuilder) by executing:
```bash
python run.py release
```
|