Skip to content

Commit

Permalink
Merge branch 'develop' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
urda committed Sep 17, 2017
2 parents a3ad356 + 5059ee9 commit 43e0c3d
Show file tree
Hide file tree
Showing 84 changed files with 19,070 additions and 1,067 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Expand Up @@ -32,7 +32,7 @@ Once you have your local `virtualenv` ready to go, simply install the full dev t
pip install -r requirements-dev.txt
```

If you have have problems installing `pycrypto`, you may need `python3-dev` or a similar library on your
If you have have problems installing `pycryptodome`, you may need `python3-dev` or a similar library on your
machine. For Ubuntu and other linux systems `apt-get install python3-dev` will usually set you straight.
Once you have it installed try running your `pip install` command again. **If this still does not work**
please add a note in this [GitHub Issue](https://github.com/urda/nistbeacon/issues/4) and then open
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Expand Up @@ -6,7 +6,7 @@ dist/
MANIFEST

# Sphinx
docs/_build
sphinx/_build

# Testing
.coverage
Expand Down
45 changes: 28 additions & 17 deletions CHANGELOG.md
@@ -1,6 +1,17 @@
# Python NIST Randomness Beacon CHANGELOG
# CHANGELOG

## v0.9.3 (Beta Release)
## v0.9.4

- Project Changes
- Switched to `pycryptodome` from `pycrypto`.
- Started locking versions for `requirements.txt`.
- Created a `sphinx` based documentation site.
- Internal Changes
- Synced `LICENSE` file to use boilerplate notice.
- Removed `nist_records` dependency on `NistBeaconValue`
- Removed `local_record_db`. Most records are stored in `json` now.

## v0.9.3

- Updated `LICENSE` to work with GitHub LICENSE features.
- Updated `README` links for Codecov,
Expand All @@ -10,7 +21,7 @@
- https://github.com/urda/nistbeacon/issues/22
- https://github.com/urda/nistbeacon/issues/26

## v0.9.2 (Beta Release)
## v0.9.2

- Internal Changes
- LICENSE
Expand All @@ -26,7 +37,7 @@
- Coverage Tool
- Switched from Coveralls to Codecov.

## v0.9.1 (Beta Release)
## v0.9.1

- Internal Changes
- `NistBeacon`
Expand All @@ -42,15 +53,15 @@
other `NistBeaconValue` do not have to generate the full RSA objects.
- Started using the now existing `xmlns` property directly from NIST.

## v0.9.0 (Beta Release)
## v0.9.0

- Features
- `NistBeaconValue`
- Added a `pseudo_random` property.
Returns a `random.Random` object that has been seeded with
the `output_value` for a given `NistBeaconValue`.

## v0.8.3 (Alpha Release)
## v0.8.3

- Internal Changes
- `NistBeaconValue`
Expand All @@ -60,7 +71,7 @@
- Project Changes (for Developers)
- `pylint` has been added to the project and build process.

## v0.8.2 (Alpha Release, Bug Fix)
## v0.8.2

- Bug Fixes:
- `NistBeaconValue`
Expand All @@ -69,43 +80,43 @@
is just a bug fix release. This `xmlns` value will not show up if one was to
use the `xml` value from the `NistBeaconValue` object.

## v0.8.1 (Alpha Release)
## v0.8.1

- Minor documentation changes

## v0.8.0 (Alpha Release)
## v0.8.0

- Features
- `NistBeaconValue`
- Added `json` and `xml` as properties (replaces `to_json()` and `to_xml()`)

## v0.7.0 (Alpha Release)
## v0.7.0

- Name changes
- Changed from `py_nist_beacon` to `nistbeacon`
- Changed from `NistRandomnessBeacon` to `NistBeacon`
- Changed from `NistRandomnessBeaconValue` to `NistBeaconValue`

## v0.6.0 (Alpha Release)
## v0.6.0

- Features
- `NistRandomnessBeacon`
- Added a `get_first_record` method. An optional boolean flag named
`download` allows the caller to either use the local first record
object, or to download the first record directly from the NIST beacon.

## v0.5.2 (Alpha Release)
## v0.5.2

- Added a section on installation.
- Updated `CONTRIBUTING`
- Re-do `PHONY` targets in `Makefile`
- Update `travis` build steps to include `3.5-dev` and `nightly`

## v0.5.1 (Alpha Release)
## v0.5.1

- Badges made to point to their release branches

## v0.5.0 (Alpha Release)
## v0.5.0

- General
- Lots of documentation added through `docstrings`! :memo:
Expand Down Expand Up @@ -133,7 +144,7 @@ def chain_check(cls, timestamp: int) -> bool:
- Introduced `valid_signature` as a `bool` property.
**Replaces `verify_signature`**

## v0.4.0 (Alpha Release)
## v0.4.0

- Added a `verify_signature` to `NistRandomnessBeaconValue` objects.
This method returns a `True` or `False` after verifying the provided
Expand All @@ -152,10 +163,10 @@ def chain_check(cls, timestamp: int) -> bool:
- If either of the steps are found to be invalid, `verify_signature` will
return a `False` result.

## v0.3.0 (Alpha Release)
## v0.3.0

- Added `to_xml`, `to_json`, and `from_json` methods on beacon values

## v0.2.0 (Alpha Release)
## v0.2.0

- Initial PyPI release package
2 changes: 1 addition & 1 deletion LICENSE
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2015-2016 Peter Urda
Copyright {yyyy} {name of copyright owner}

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
19 changes: 18 additions & 1 deletion Makefile
Expand Up @@ -4,16 +4,20 @@ help: # Show this help screen
sort |\
awk 'BEGIN {FS = ":.*?# "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'


.PHONY: build
build: test clean build-package # Clean, Test, and Build the package


.PHONY: build-package
build-package: # Build 'sdist' for this package
python setup.py sdist


.PHONY: test
test: pep8 pylint unittest integration version-check # Run the full Travis CI testing suite


.PHONY: clean
clean: # Clean up build, test, and other project artifacts
rm -rf \
Expand All @@ -28,30 +32,43 @@ clean: # Clean up build, test, and other project artifacts
find . | grep -E "(__pycache__|\.pyc|\.pyo$$)" | xargs rm -rf \
&& :


.PHONY: docs
docs: # Build the documentation
cd ./docs && make html
pandoc --from markdown_github --to rst ./CHANGELOG.md > ./sphinx/changelog.rst && \
pushd ./sphinx && \
make clean && \
make html && \
popd && \
rsync -av --delete sphinx/_build/html/ docs/
:


.PHONY: integration
integration: # Run only integration tests
py.test ./tests/integration/


.PHONY: pep8
pep8: # Run pep8 against project files
pep8 --verbose ./nistbeacon/* ./scripts/* ./tests/*


.PHONY: publish
publish: build # Build, sign, and publish the package
twine upload dist/* --sign -r pypi


.PHONY: pylint
pylint: # Run pylint against project files
pylint --rcfile=./.pylintrc --reports=y --output-format=text nistbeacon


.PHONY: unittest
unittest: # Run only unit tests
py.test --cov nistbeacon --cov-report html ./tests/unit/


.PHONY: version-check
version-check: # Verify the project version string is correct across the project
./scripts/version_manager.py check

0 comments on commit 43e0c3d

Please sign in to comment.