diff --git a/CHANGELOG.md b/CHANGELOG.md index c7e92345efdf7e3c3c94928324c8e31bbee6797a..5bc58e9a0a7ea35bcd1c0d896ecb1e68b0aa0c75 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,38 +1,67 @@ -# Changelog +# Changelog # + All notable changes to this project will be documented in this file. 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] ## + +### Added ### + +### Changed ### + +### Deprecated ### +### Fixed ### -## [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 ## -## [0.1.0] - 2018-10-09 Tag `v0.1` - Commit 6fc0dcaa diff --git a/README.md b/README.md index 242081ba042969b4728ec330ac8d2f4d93626bc9..ef26a604905d5140ae9a775065002af35ffe2121 100644 --- a/README.md +++ b/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). diff --git a/RELEASE_GUIDELINES.md b/RELEASE_GUIDELINES.md index 2f53e48f0541a30c6812a96cfe7613267ada5065..48eb270e6f5dc29b4d9ee85d275d6fe7eba1ffd6 100644 --- a/RELEASE_GUIDELINES.md +++ b/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.