Skip to content

Commit

Permalink
document pipenv install and flake8
Browse files Browse the repository at this point in the history
  • Loading branch information
wjmelements committed Aug 2, 2019
1 parent 8176346 commit d2cfafa
Show file tree
Hide file tree
Showing 10 changed files with 204 additions and 6 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ __pycache__

# Packaging
build/
dist/

# Pipenv
.venv

# VIM
*.swo
Expand Down
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ Start by cloning the repository.
git clone [email protected]:trusttoken/bnb-tx-python.git
```

Install dependencies
```
pipenv install
```

Run flake8
```
pipenv run flake8
```

# Pull Requests
Please try to adhere to the following guidelines.

Expand Down
16 changes: 16 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true


[dev-packages]
pytest = "~=4.0"
flake8 = "==3.6"


[packages]
ecdsa = "==0.13.2"

[requires]
python_version = "3.7"
145 changes: 145 additions & 0 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion binance_transaction/tests/test_base.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from .base import Bool, Bytes, String, StringVarInt, VarInt
from binance_transaction.base import Bool, Bytes, String, StringVarInt, VarInt


import base64
Expand Down
4 changes: 2 additions & 2 deletions binance_transaction/tests/test_dex.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
import hashlib


from .bnb_transaction import BnbTransaction
from .crypto import uncompress_key, verify_sig
from binance_transaction.bnb_transaction import BnbTransaction
from binance_transaction.crypto import uncompress_key, verify_sig


def test_new_order():
Expand Down
4 changes: 2 additions & 2 deletions binance_transaction/tests/test_gov.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import base64
import hashlib

from .bnb_transaction import BnbTransaction
from .crypto import verify_sig, uncompress_key
from binance_transaction.bnb_transaction import BnbTransaction
from binance_transaction.crypto import verify_sig, uncompress_key


def test_vote_encoding():
Expand Down
2 changes: 2 additions & 0 deletions pytest.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[pytest]
testpaths = binance_transaction
21 changes: 21 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import setuptools

with open("README.md", "r") as fh:
long_description = fh.read()

setuptools.setup(
name="binance_transaction",
version="0.0.1",
author="William Morriss",
author_email="[email protected]",
description="Binance Chain Transactions",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/trusttoken/bnb-tx-python",
packages=setuptools.find_packages(),
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
)
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[flake8]

max-line-length = 120
exclude = build
exclude = build,.venv

0 comments on commit d2cfafa

Please sign in to comment.