Skip to content

Commit

Permalink
Prepare Release 1.2.0
Browse files Browse the repository at this point in the history
Update version and CHANGELOG for minor release.
  • Loading branch information
VaeterchenFrost committed Dec 18, 2024
1 parent d8ee95f commit f4e1627
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 40 deletions.
147 changes: 109 additions & 38 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,170 +2,239 @@

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 ).
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]

- No unreleased changes yet.

## [1.2.0] - 2024-12-24

### Added

- Testsetup with python-version: `3.12` while maintaining `3.8 compatibility`
- Specifying `psycopg[c]` for distribution: https://www.psycopg.org/psycopg3/docs/basic/install.html#local-installation
See [Installation](https://www.psycopg.org/psycopg3/docs/basic/install.html#installation) for the other options.
- Several improvements and specifications to `.github\workflows\python-app.yml`

### Changed

See [#47]

- Updated GitHub Actions #48
- Replacing installation of `setuptools` with
> pip install 'build[virtualenv]'
- Replacing old `python setup.py sdist bdist_wheel` with
> python -m build
- Updated `author_email` to <[email protected]>
- Update and format `setup.py`
- Updated tests for graphviz-version: `12.2.1` from usually version `2` before. Changed the output files slightly with the test settings. They look a bit cleaner, see also their https://gitlab.com/graphviz/graphviz/-/blob/main/CHANGELOG.md
- Upgrade code for
- [psycopg](https://pypi.org/project/psycopg)==3.2.3 \
Update _wait for good connection_, replacing the `good_db_status()` method with **pg.pq.ConnStatus.OK**
- [pytest](https://pypi.org/project/pytest)==8.3.4
- Updated requirements.txt
- Updated stable-requirements.txt

## [1.1.9] - 2023-07-27

### Added

- `python-benedict[xml]` to dependencies

### Changed

- Updated requirements.txt
- Updated stable-requirements.txt


## [1.1.8] - 2021-05-04

### Changed

- Updated pyyaml from 5.3.1 to 5.4 [#33]
- Updated py from 1.9.0 to 1.10.0 [#35]
- Fixed python-app.yml [#34]

## [1.1.7] - 2020-09-13

### Added

- Better tests around the (Dimacs) Reader

### Changed

- Improved the SQL queries with explicit formats [#32]
- Improved Readme sections for install and usage

## [1.1.6] - 2020-08-01

### Added
- Added better property based testing with *hypothesis* [#29]

- Added better property based testing with _hypothesis_ [#29]
- Added jobs and setups to test on macos and windows [#31]

### Changed
- *do_sort_nodes* now sorts in correct numeric order. [commit cdfcf6](https://github.com/VaeterchenFrost/tdvisu/commit/cdfcf6c332a63f05b499fe133fada4473ad7524c )

- _do_sort_nodes_ now sorts in correct numeric order. [commit cdfcf6](https://github.com/VaeterchenFrost/tdvisu/commit/cdfcf6c332a63f05b499fe133fada4473ad7524c)
- Fixed some import orders

## [1.1.5] - 2020-07-17

### Added

- Added many new tests.
- Hints for not covered code lines.

### Changed

- Simplified code to parse commandline flags while removing duplications in code.
- Entrypoint for modules visualization and construct_dpdb_visu is now in init().
- Some improvements in utilities.solution_node

## [1.1.4] - 2020-07-14

### Added

- Added the possibility to specify and create multiple graph-visualizations in one file [#25]
- Added test case *test_vc_multiple_and_join* in [commit aa31901](https://github.com/VaeterchenFrost/tdvisu/commit/aa319016ac71f9a54023474bf820cb30929c52a8 )
- Added test cases for [construct_dpdb_visu](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_construct_dpdb.py )
- Added test case _test_vc_multiple_and_join_ in [commit aa31901](https://github.com/VaeterchenFrost/tdvisu/commit/aa319016ac71f9a54023474bf820cb30929c52a8)
- Added test cases for [construct_dpdb_visu](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_construct_dpdb.py)
- Add pytest-mock to tests_require

### Changed
- Simplified and refactored TDVisu.schema.json
- Schema now includes possibility to specify multiple instances of generalGraph and incidenceGraph

- Simplified and refactored TDVisu.schema.json
- Schema now includes possibility to specify multiple instances of generalGraph and incidenceGraph
- Revisited doc/JsonAPI.md to now include all parameters available
- Renamed test folder expected_images to expected_files
- Updated stable-requirements.txt
- Several minor improvements

## [1.1.3] - 2020-07-09

### Added
- Added *TDVisu.schema.json* to validate the Json-API for TDVisu [#24]

- Added _TDVisu.schema.json_ to validate the Json-API for TDVisu [#24]
- Added 'col' to allowed formats in tw reader (default string in Mathematica)

### Changed

- Fixed error where database configuration was not found in the directory
- Fixed missing double quotation marks in JsonAPI.md
- Moved JsonAPI.md → *doc/JsonAPI.md*
- Moved JsonAPI.md → _doc/JsonAPI.md_

### Removed
- Removed *generalGraph* and *incidenceGraph* from required arguments in API

- Removed _generalGraph_ and _incidenceGraph_ from required arguments in API

## [1.1.2] - 2020-06-26

### Added

- Tests for visualization.py using graphviz in the Github Action too
- Tests for reader.py

### Changed

- Fixed typo that prevented joining SVG in visualization
- Fixed cases where logging.yml was not found in the working directory
- Now using pathlib.Path for most file-related operations
- Unified logging configuration in utilities and made it easier to work with [#22]
- Added more type hints and improved existing ones

## [1.1.1] - 2020-06-25

### Added
- Added problem type **Sat** to tdvisu/construct_dpdb_visu.py

- Added problem type **Sat** to tdvisu/construct_dpdb_visu.py
- Added testcases in file test/test_dijkstra.py

### Changed
- JsonAPI.md is now updated with snake_case names and consistent with visualization_data.py
- Fixed default value for svg-join **v_top** to *None* from *'top'*

- JsonAPI.md is now updated with snake_case names and consistent with visualization_data.py
- Fixed default value for svg-join **v_top** to _None_ from _'top'_
- Improved flexibility in several function parameters
- Improved documentation and comments in several places
- Fixed passing parameters to method *setup_tree_dec_graph*
- Fixed passing parameters to method _setup_tree_dec_graph_

### Removed
- Removed old dependency from tdvisu/dijkstra.py on utilities

- Removed old dependency from tdvisu/dijkstra.py on utilities

## [1.1.0] - 2020-06-07

### Added

- Added file utilities.py with several static or shared things like
- Constants: CFG_EXT, LOGLEVEL_EPILOG, DEFAULT_LOGGING_CFG
- Methods:
- flatten
- read_yml_or_cfg combining yaml, json, cfg reader in one
- logging_cfg configure logging with file or DEFAULT_LOGGING_CFG
- helper convert_to_adj from dijkstra.py
- add_edge_to (edges and adj list)
- gen_arg infinite Generator
- Styles:
- base_style, emphasise_node, style_hide_node, style_hide_edge
- Graph manipulation:
- bag_node
- solution_node

- Constants: CFG_EXT, LOGLEVEL_EPILOG, DEFAULT_LOGGING_CFG
- Methods:
- flatten
- read_yml_or_cfg combining yaml, json, cfg reader in one
- logging_cfg configure logging with file or DEFAULT_LOGGING_CFG
- helper convert_to_adj from dijkstra.py
- add_edge_to (edges and adj list)
- gen_arg infinite Generator
- Styles:
- base_style, emphasise_node, style_hide_node, style_hide_edge
- Graph manipulation:
- bag_node
- solution_node

- Added file logging.yml (and .ini) with logging configuration for the module [#20]
- Added half the tests for utilities.py

### Changed

- Changed path of image SharpSatExample to the absolute URL for [PyPI].
- Changed names of loggers to absolute name. Should be easy to adjust if needed.
- Changed logging defaults and config in tdvisu/visualization.py and construct_dpdb_visu.py
- Updated ArgumentParser help
- Some fixes of code-style or variable names.
- Some fixes of code-style or variable names.

## [1.0.1] - 2020-06-04

### Added

- Codecoverage with [Codecov]

### Changed

- Changed path of image SharpSatExample to the absolute URL for [PyPI].

## [1.0.0] - 2020-06-04

### Added

- Added svgjoin parameters to JsonAPI [#6]
- Added call to svgjoin from visualization.py
- Added workflow to display the sourcecode-files in [DIRECTORY]

### Changed
### Changed

- Moved JsonAPI and conda_packages to /doc
- Updated arguments in svgjoin to be more flexible for multiple joins [#11]
- Fixed scaling mechanism in svgjoin [#13]
- Changed tests from unittest to pytest [#12]

### Removed

- Changelog in JsonAPI.md

## [0.5.1] - 2020-06-01

### Added

- Added publishing Action to [PyPI] [#4]

### Changed

- Changed setup.py with more documentation and simpler functionality.
- Updated Readme with a guide on how to use construct_dpdb_visu [#2]

### Removed
- Removed publishing Action to testpypi [#4]

- Removed publishing Action to testpypi [#4]

## [0.5.0-dev1] - 2020-06-01

Expand All @@ -177,10 +246,12 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html ).
- Added README to tdvisu directly

### Changed

- Fixed usage of `__version__` in tdvisu/construct_dpdb_visu.py

### Removed
- Removed individual versioning

- Removed individual versioning

[#1]: https://github.com/VaeterchenFrost/tdvisu/issues/1
[#2]: https://github.com/VaeterchenFrost/tdvisu/issues/2
Expand All @@ -199,15 +270,15 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html ).
[#33]: https://github.com/VaeterchenFrost/tdvisu/pull/33
[#34]: https://github.com/VaeterchenFrost/tdvisu/pull/34
[#35]: https://github.com/VaeterchenFrost/tdvisu/pull/35

[#47]: https://github.com/VaeterchenFrost/tdvisu/pull/47
[@VaeterchenFrost]: https://github.com/VaeterchenFrost
[PyPI]: https://pypi.org/project/tdvisu/
[mypy]: https://github.com/python/mypy
[DIRECTORY]: https://github.com/VaeterchenFrost/tdvisu/blob/master/DIRECTORY.md
[Codecov]: https://codecov.io/gh/VaeterchenFrost/tdvisu

[Unreleased]: https://github.com/VaeterchenFrost/tdvisu/compare/v1.1.9...master
[1.1.8]: https://github.com/VaeterchenFrost/tdvisu/releases/tag/v1.1.9
[Unreleased]: https://github.com/VaeterchenFrost/tdvisu/compare/v1.2.0...master
[1.2.0]: https://github.com/VaeterchenFrost/tdvisu/releases/tag/v1.2.0
[1.1.9]: https://github.com/VaeterchenFrost/tdvisu/releases/tag/v1.1.9
[1.1.8]: https://github.com/VaeterchenFrost/tdvisu/releases/tag/v1.1.8
[1.1.7]: https://github.com/VaeterchenFrost/tdvisu/releases/tag/v1.1.7
[1.1.6]: https://github.com/VaeterchenFrost/tdvisu/releases/tag/v1.1.6
Expand Down
4 changes: 2 additions & 2 deletions tdvisu/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"""

# Base version.
__version__ = "1.1.9"
__version__ = "1.2.0"

# Year-Month-Day of last version change
__date__ = "2023-07-27"
__date__ = "2024-12-24"

0 comments on commit f4e1627

Please sign in to comment.