mirror of
https://github.com/bendtherules/humblematch.git
synced 2026-08-18 13:52:00 +00:00
Moved tests + removed extra img
This commit is contained in:
@@ -1,18 +1,49 @@
|
||||
# HumbleMatch
|
||||
--------------
|
||||
Will **Sanitize your type-checks and duck-checks** for you
|
||||
|
||||
")
|
||||
|
||||
Available at [HumbleMatch@pypi](https://pypi.python.org/pypi/humblematch)
|
||||
|
||||
|
||||
## Run doctest -
|
||||
## What the heck is it?
|
||||
|
||||
HumbleMatch is made to *add a zing* to your mundane type-checking and duck-checking code.
|
||||
|
||||
* Check your function arguments reliably, add *more flexible signatures* and most of all, have a lovely API.
|
||||
* Or just *sprinkle some assert* checks to ensure the data is what you expect it to be at any point.
|
||||
* Provide helpful debugging errors, *dont just fail with cryptic errors*
|
||||
|
||||
More Docs at projects.codesp.in/humblematch
|
||||
|
||||
## Get Running
|
||||
--------------
|
||||
|
||||
### Run doctest -
|
||||
|
||||
python -m doctest .\wrap_obj.py
|
||||
|
||||
## Run tests-
|
||||
### Run tests-
|
||||
cd humblematch
|
||||
py.test
|
||||
|
||||
## To build -
|
||||
### To build code -
|
||||
|
||||
python setup.py sdist bdist_wheel
|
||||
python setup.py build --plat-name=win-amd64 bdist_wininst
|
||||
python setup.py build --plat-name=win32 bdist_wininst
|
||||
|
||||
To upload -
|
||||
### To upload to PYPI-
|
||||
|
||||
twine upload dist/*
|
||||
|
||||
### To build or serve docs
|
||||
|
||||
mkdocs build
|
||||
|
||||
or
|
||||
|
||||
mkdocs serve
|
||||
|
||||
-----
|
||||
|
||||
Reference in New Issue
Block a user