Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cheeseandcereal committed Aug 1, 2019
1 parent 2a2a6a0 commit 89ff1d1
Show file tree
Hide file tree
Showing 256 changed files with 21,914 additions and 12,746 deletions.
40 changes: 40 additions & 0 deletions .dockerignore
@@ -0,0 +1,40 @@
# python
__pycache__/
*.py[cod]
*$py.class
.mypy_cache

# testing / development
coverage.xml
.coverage
.env
.envrc
.direnv
.venv

# CI/CD (Docker only)
.git
.gitignore
.dockerignore
Dockerfile
cicd/
scripts/
README*
.github
docs/

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# ide
.idea
.vscode
*.swp

# OS Files
.DS_Store
desktop.ini

# redis
dump.rdb
8 changes: 8 additions & 0 deletions .flake8
@@ -0,0 +1,8 @@
[flake8]
ignore = E203, E266, E501, W503
max-line-length = 150
max-complexity = 15
import-order-style = pep8
application-import-names = dragonchain
select = A,B,B9,C,E,F,I,N,T4,W
mypy-config = mypy.ini
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
@@ -0,0 +1 @@
* @cheeseandcereal @deanshelton913 @regan-karlewicz
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.md
@@ -0,0 +1,21 @@
---
name: Bug report
about: Create a report to help us improve
---

<!--
Thank you for reporting a possible bug in Dragonchain
Please fill in the items in the template below before describing the bug.
Dragonchain Version: This is the contents of the `.version` file in the docker container where you're experiencing the bug
Entrypoint: The entrypoint used to start the container which experienced the bug (webserver, transaction processor, contract invoker, broadcast processor, scheduler, etc)
Please provide as detailed reproduction steps as possible in order to assist us diagnose the problem faster.
See the contributing guideline for more details on making a good bug report: https://github.com/dragonchain/dragonchain/blob/master/CONTRIBUTING.md#bug-reports
-->

- **Dragonchain Version**:
- **Entrypoint**:

<!-- Please provide more details below this comment. -->
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.md
@@ -0,0 +1,17 @@
---
name: Feature Request
about: Suggest an idea for this project
---

<!--
Thank you for suggesting an idea to make Dragonchain better.
Please fill in as much of the template below as you're able. Delete any sections that aren't relevant.
See the contributing guideline for more details on making a good feature request: https://github.com/dragonchain/dragonchain/blob/master/CONTRIBUTING.md#feature-requests
-->

**Is your feature request related to a problem? Please describe.**
Please describe the problem you are trying to solve.

**Describe the solution you'd like**
Please describe the desired behavior.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/3-question.md
@@ -0,0 +1,9 @@
---
name: Question
about: The issue tracker is not for questions. Please check the docs or use the developer Dragonchain Slack
---

!!! The issue tracker is not for questions !!!

Please first check the [docs](https://dragonchain-core-docs.dragonchain.com/latest/),
if your question is still not answered, please use the developer chat [Dragonchain Slack](https://forms.gle/ec7sACnfnpLCv6tXA)
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,21 @@
<!--
Thank you for your pull request. Please ensure that you've reviewed the contributors guide:
https://github.com/dragonchain/dragonchain/blob/master/CONTRIBUTING.md
Please ensure to provide a good title and description for the pull request
Note that bug fixes and new features should include tests.
-->

## Description

<!-- Put your pull request description here, and be sure to link any relevant github issues -->

##### Checklist

<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->

- [ ] `./tools.sh full-test` passes
- [ ] tests are included
- [ ] documentation is changed or added
- [ ] changelog has been modified for the changes
121 changes: 17 additions & 104 deletions .gitignore
@@ -1,118 +1,31 @@
# Byte-compiled / optimized / DLL files
# python
__pycache__/
*.py[cod]
*$py.class
.mypy_cache

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# testing / development
coverage.xml
.coverage
.env
.envrc
.direnv
.venv

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# IPython Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# dotenv
.env

# virtualenv
venv/
ENV/

# Spyder project settings
.spyderproject

# Rope project settings
.ropeproject

# PyCharm
# ide
.idea
*.iml

# logs
logs/
*.swp

# pki
pki/
# Docs
.build

# .DS_Store
# OS Files
.DS_Store
desktop.ini

# config
configs/

#docker
docker/custom*compose.yml

#eclipse,pydev
.metadata/
.project
.pydevproject

# Emacs


~
# redis
dump.rdb
26 changes: 12 additions & 14 deletions .travis.yml
@@ -1,15 +1,13 @@
language: python
python:
- "2.7"

env:
- PYTHONPATH=~/build/dragonchain/dragonchain

sudo: required

# command to install dependencies
install: "pip install -r requirements.txt"

# command to run tests
services:
- docker
before_script:
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
- chmod +x ./cc-test-reporter
- ./cc-test-reporter before-build
script:
- python blockchain/tests/crypto_utest.py
- docker build . -f cicd/Dockerfile.test -t built
- docker run -v $(pwd)/docs:/usr/src/core/docs built
- if [ ! -d "./docs/.build/html" ]; then echo "Docs did not build correctly!"; exit 1; fi
- mv docs/coverage.xml ./coverage.xml
after_script:
- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
1 change: 1 addition & 0 deletions .version
@@ -0,0 +1 @@
3.4.46
16 changes: 16 additions & 0 deletions .vscode/settings.json
@@ -0,0 +1,16 @@
{
"files.watcherExclude": {
"**/.mypy_cache": true,
"**/.venv": true
},
"python.linting.flake8Enabled": true,
"python.formatting.provider": "black",
"python.formatting.blackArgs": [
"-l",
"150",
"-t",
"py37"
],
"editor.formatOnSave": true,
"restructuredtext.confPath": "${workspaceFolder}/docs"
}
52 changes: 52 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,52 @@
# Changelog

## 3.4.46

- **Bug:**
- Don't require registration to bitcoin node on webserver boot
- Properly handle 401-403 responses from matchmaking
- **Documentation:**
- Update documentation for slack channel
- Update deployment docs for more clarity
- Update and fix docs helm chart to better work with open source chains
- Update README
- **Packaging:**
- Update boto3, redis, and kubernetes dependencies
- Update fwatchdog to 0.15.4 for OpenFaaS smart contracts

## 3.4.45

- **Bug:**
- Fix bug with job processor consuming too much memory due to threads

## 3.4.43

- **Feature:**
- Add route versioning (old routes are still backwards compatible)
- Removed the interim matchmaking hack for old claim check compatibility
- Sped up schema validation for http requests significantly
- Added nickname functionality for api keys
- Added matchmaking registration token support
- Index transaction upon acceptance so immediate transaction lookups don't produce 404s
- Add endpoint (/v1/verifications/pending/<block_id>) to get pending verification chain ids
- **Documentation:**
- Added documentation with [new docs site](https://dragonchain-core-docs.dragonchain.com/latest/)
- Updated README
- Added changelog
- **Development:**
- Added and started enforcing stricter typing
- Added codeowners required for PR reviews
- Added issue templates for github
- Added committed/shared VSCode settings for linting/formatting
- Improved error handling
- Move webserver endpoints into routes module
- **Packaging:**
- Switched Dockerfile to be based on python alpine image
- Ignored more unnecessary files for docker builds
- Switched jsonshema dependency for fastjsonschema
- Update fwatchdog to 0.15.2 for OpenFaaS smart contracts
- **CICD:**
- Updated cicd for new AWS buildspec runtimes
- **Bug Fixes**
- No longer send HTML on certain 500 responses, only JSON
- Remove any possible existing entrypoints from built smart contract containers

0 comments on commit 89ff1d1

Please sign in to comment.