Skip to content

Commit

Permalink
Merge pull request #2 from Parquery/mristin/fixed-README-and-setup.py…
Browse files Browse the repository at this point in the history
…-links

fixed links in README and setup.py
  • Loading branch information
Marko Ristin authored Jul 31, 2018
2 parents 48f4dbe + 84b7b6b commit 654d8fb
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 13 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
1.0.1
=====
* Fixed links in the README and setup.py

1.0.0
=====
* Initial version
25 changes: 14 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
icontract
=========

icontract provides design-by-contract to Python3 with informative violation messages.
icontract provides `design-by-contract <https://en.wikipedia.org/wiki/Design_by_contract>`_ to Python3 with informative
violation messages.

There exist a couple of contract libraries. However, at the time of this writing (July 2018), they all required the
programmer either to learn a new syntax (`PyContracts<https://pypi.org/project/PyContracts/>`_) or to write
redundant condition descriptions (*e.g.*, `contracts<https://pypi.org/project/contracts/>`_,
`covenant<https://github.com/kisielk/covenant>_`,
`dpcontracts<https://pypi.org/project/dpcontracts/>`_,
`pyadbc<https://pypi.org/project/pyadbc/>`_ and.
`pcd<https://pypi.org/project/pcd>`_).

This library was strongly inspired by them, but we went a step further and use the
`meta<https://github.com/srossross/Meta>`_ programming library to infer violation messages from the code in order to
promote dont-repeat-yourself principle (`DRY<https://en.wikipedia.org/wiki/Don%27t_repeat_yourself`_) and spare the
programmer either to learn a new syntax (`PyContracts <https://pypi.org/project/PyContracts/>`_) or to write
redundant condition descriptions (
*e.g.*,
`contracts <https://pypi.org/project/contracts/>`_,
`covenant <https://github.com/kisielk/covenant>`_,
`dpcontracts <https://pypi.org/project/dpcontracts/>`_,
`pyadbc <https://pypi.org/project/pyadbc/>`_ and
`pcd <https://pypi.org/project/pcd>`_).

This library was strongly inspired by them, but we go a step further and use the
`meta <https://github.com/srossross/Meta>`_ programming library to infer violation messages from the code in order to
promote dont-repeat-yourself principle (`DRY <https://en.wikipedia.org/wiki/Don%27t_repeat_yourself>`_) and spare the
programmer the tedious task of repeating the message that was already written in code.

We want this library to be used mainly in production code and let us spot both development and production bugs with
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@

setup(
name='icontract',
version='1.0.0',
version='1.0.1',
description='Provide design-by-contract with informative violation messages',
long_description=long_description,
url='https://https://github.com/Parquery/icontract',
url='https://github.com/Parquery/icontract',
author='Marko Ristin',
author_email='[email protected]',
classifiers=[
Expand Down

0 comments on commit 654d8fb

Please sign in to comment.