Preparing release 0.2.4: Changelog, Readme.

CHANGELOG.md

@@ -5,31 +5,48 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
-
-
-## [Unreleased]
+## [0.2.4]
 
 ### Added
-- An `auth_token` parameter for `caosdb.configure_connection(...)`. This parameter accepts a plain text auth token (which can only be issued by the CaosDB Server). Under the hood, auth tokens are stored plain, instead of urlencoded now.
+
+- An `auth_token` parameter for `caosdb.configure_connection(...)`. This
+  parameter accepts a plain text auth token (which can only be issued by the
+  CaosDB Server). Under the hood, auth tokens are stored plain, instead of
+  urlencoded now.
 - New type of exception: `ConfigurationException` for misconfigurations.
 - Some unit tests, mainly for the `caosdb.connection.authentication` module
-* Advanced setup.py for easy versioning and publication as pypi repository.
+- Advanced setup.py for easy versioning and publication as pypi repository.
+- `caosdb.apiutils` has new functions `id_query` and
+  `retrieve_entities_with_ids`
+- New exception: `EntityDoesNotExistError`
+- `RELEASE_GUIDELINES.md` with release instructions.
+- More documentation and tests.
 
 ### Changed
-- [pytest](https://docs.pytest.org/en/latest/) is the new preferred unit test frame work.
-- If a password is specified in the configuration even though the password_method is not set to `plain`, a warning is logged.
-- Under the hood, the password of from a `pass` or `keyring` call is not stored anymore. Instead the password is requested each time a login is necessary.
-- Always load system default CA repository into the ssl context
 
+- [pytest](https://docs.pytest.org/en/latest/) is the new preferred unit test
+  frame work.
+- If a password is specified in the configuration even though the
+  password_method is not set to `plain`, a warning is logged.
+- Under the hood, the password of from a `pass` or `keyring` call is not stored
+  anymore. Instead the password is requested each time a login is necessary.
+- Always load system default CA repository into the ssl context.
+- Datatypes are now in `caosdb.common.datatype` (though still available in the
+  main `caosdb` namespace).
+- Logging to stdout is now more configurable.
 
 ### Deprecated
-- Unit test frame work: [Nose](https://nose.readthedocs.io/en/latest/) should not be used anymore. Please use [pytest](https://docs.pytest.org/en/latest/) instead.
+
+- Unit test frame work: [Nose](https://nose.readthedocs.io/en/latest/) should
+  not be used anymore. Please use [pytest](https://docs.pytest.org/en/latest/)
+  instead.
 
 ### Fixed
+
 - #1 - Problems with pass as a credentials provider
 - #3 - Python client does login before the first request to circumvent problems
   with anonymous role.
-
+- Many other fixes
 
 
 ## [0.1.0] - 2018-10-09

README.md

@@ -18,6 +18,7 @@ project](https://gitlab.com/caosdb/caosdb) for more information.
 
 Copyright (C) 2018 Research Group Biomedical Physics, Max Planck Institute for
 Dynamics and Self-Organization Göttingen.
+Copyright (C) 2020 Indiscale GmbH <info@indiscale.com>
 
 All files in this repository are licensed under a [GNU Affero General Public
 License](LICENCE.md) (version 3 or later).

RELEASE_GUIDELINES.md

@@ -18,7 +18,9 @@ guidelines of the CaosDB Project
 
 2. Check all general prerequisites.
 
-3. Prepare the [setup.py](./setup.py): Update the `MAJOR`, `MINOR`, `MICRO`, `PRE` variables and set `ISRELEASED` to `True`. Use the possibility to issue pre-release versions for testing.
+3. Prepare [setup.py](./setup.py): Update the `MAJOR`, `MINOR`, `MICRO`, `PRE`
+   variables and set `ISRELEASED` to `True`. Use the possibility to issue
+   pre-release versions for testing.
 
 4. Merge the release branch into the master branch.