Skip to content

Commit

Permalink
New-style readme, change log and license
Browse files Browse the repository at this point in the history
  • Loading branch information
cjw296 committed May 5, 2024
1 parent 8db129c commit a2e7e08
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 66 deletions.
43 changes: 43 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Changes
=======

2.1.2 (31 Jan 2019)
-------------------

- Fix bug in :class:`~chide.Collection` occurring when sample attributes were
not hashable.

2.1.1 (9 Jan 2019)
-------------------

- Exclude tests from distribution.

2.1.0 (22 Nov 2018)
-------------------

- add :meth:`~chide.Collection.attributes`.

2.0.1 (16 Jun 2016)
-------------------

- Fix nasty bug when using with :doc:`sqlalchemy <sqlalchemy:index>` where related objects could get
added to the session even though they were never requested, as a result of
a backref on a third model.

2.0.0 (21 Apr 2016)
-------------------

- Backwards incompatible change to split the concern for sample object
identity out into :class:`chide.Set` and :class:`chide.sqlalchemy.Set`
to avoid module-level :class:`~chide.Collection` instances resulting
in cross-test pollution.

1.0.2 (15 Apr 2016)
-------------------

- Fix release faults.

1.0.0 (14 Apr 2016)
-------------------

- Initial release
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Copyright (c) 2016 onwards Chris Withers

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
43 changes: 2 additions & 41 deletions docs/changes.rst
Original file line number Diff line number Diff line change
@@ -1,43 +1,4 @@
Changes
=======

2.1.2 (31 Jan 2019)
-------------------
.. currentmodule:: chide

- Fix bug in :class:`~chide.Collection` occurring when sample attributes were
not hashable.

2.1.1 (9 Jan 2019)
-------------------

- Exclude tests from distribution.

2.1.0 (22 Nov 2018)
-------------------

- add :meth:`~chide.Collection.attributes`.

2.0.1 (16 Jun 2016)
-------------------

- Fix nasty bug when using with :doc:`sqlalchemy <sqlalchemy:index>` where related objects could get
added to the session even though they were never requested, as a result of
a backref on a third model.

2.0.0 (21 Apr 2016)
-------------------

- Backwards incompatible change to split the concern for sample object
identity out into :class:`chide.Set` and :class:`chide.sqlalchemy.Set`
to avoid module-level :class:`~chide.Collection` instances resulting
in cross-test pollution.

1.0.2 (15 Apr 2016)
-------------------

- Fix release faults.

1.0.0 (14 Apr 2016)
-------------------

- Initial release
.. include:: ../CHANGELOG.rst
5 changes: 1 addition & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
chide documentation
===================

Quickly create sample objects from data.
.. include:: ../README.rst

.. toctree::
:maxdepth: 3
Expand Down
22 changes: 1 addition & 21 deletions docs/license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,4 @@
License
=======

Copyright (c) 2016 onwards Chris Withers

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
.. literalinclude:: ../LICENSE.txt

0 comments on commit a2e7e08

Please sign in to comment.