-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCHANGELOG.rst
executable file
·162 lines (119 loc) · 3.67 KB
/
CHANGELOG.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
=========
Changelog
=========
2.0.0 (2022-11-19)
==================
Redesign the Proxy pattern so that it is actually usefull for client code.
Now, to use the pattern one need only to import the Proxy (class) type
`from software_patterns import Proxy`
Changes
^^^^^^^
feature
"""""""
- allow flexible adaptation of Proxy pattern with a single entrypoint
refactor
""""""""
- fix type checking with mypy on python3.6
- remove Handler Prototype Pattern
- static type checking with mypy of test code (along with prod code)
ci
""
- update Codecov Job image runner to ubuntu-2004:2022
- enable CI for Python 3.11
breaking
""""""""
- Handler Pattern is no longer supported.
- Removed the ProxySubject type.
1.3.0 (2022-06-10)
==================
Releasing the Singleton Pattern, implemented as a Python Metaclass.
Changes
^^^^^^^
feature
"""""""
- add Singleton Pattern
1.2.1 (2022-05-04)
------------------
fix
^^^
- correctly declare supported types through setup.cfg and setuptools
1.2.0 (2022-05-04)
------------------
feature
^^^^^^^
- enable types to be recognized by packages importing the software_patterns library
1.1.3 (2022-04-30)
------------------
docs
^^^^
- set badges in README to target the master branch
1.1.2 (2022-04-30)
------------------
docs
^^^^
- add badge in README to show number of monthly downloads from pypi
1.1.0 (22-02-06)
-----------------
feature
^^^^^^^
- add apidoc & docs cmds to facilitate automatic docs generation & docs local build
- add memoize, notification, proxy & subclass registry software design patterns
test
^^^^
- cover all code with tests
documentation
^^^^^^^^^^^^^
- add url links to documentation, source code and ci/cd workflow
- clean readme
- update code comments
- add notes on what changes are included in the release in CHANGELOG.rst
- add developer guide & redesign chapters, sections, etc
- redesign documentation pages
- wip, dedicate a section for the patterns implementation in the documentation pages
- add docs landing page with logo & toc automatically generated with sphinx-apidoc tool
- fix doctests
- bump semantic version to 0.9.0
ci
^^
- rename job to a more intuitive name
- set the component depth to 3
- exclude 'docs' dir and all its contents from being analyzed
- exclude sphinx configuration python file from the 'production code'
- specify to treat *.py files in 'tests' dir as the 'test code'
- include only *.py files inside src/software_patterns dir as production code
- configure server to treat components starting at depth src/software_patterns/*
- configure sphinx to build the documentation files
- configure rtd to build docs with Sphinx and generate doc files in html, pdf & epub formats
- fix the installation command for job 'integration-test'
- add job to deploy package to test.pypi.org and job to install & test package after download
- fix ci workflow
- define jobs (ie build_n_test) and a workflow to run on CircleCI
1.0.0 (2022-01-10)
------------------
Changes
^^^^^^^
feature
"""""""
- include a developer guide in the documentation pages
developer
"""""""""
- add docs tox commands to facilitate automatic docs build locally
documentation
"""""""""""""
- add developer guide & redesign chapters, sections, etc
- dedicate a section for the patterns implementation in the documentation pages
- add landing page with logo
ci
""
- configure sphinx to build the documentation files
- use the readthedocs server to automatically build (generate html, pdf & epub files) and host the documentation pages
0.9.0 (2021-12-09)
------------------
Changes
^^^^^^^
feature
"""""""
- add memoize, notification, proxy & subclass registry software design patterns
ci
""
- define jobs (ie build_n_test) and a workflow to run on CircleCI