Prepare release 0.2.5

networktocode · Nov 26, 2021 · 23fb326 · 23fb326
1 parent cf6541a
commit 23fb326
Show file tree

Hide file tree

Showing 7 changed files with 289 additions and 230 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Changelog
 
+## v0.2.5 - 2021-11
+
+### Added
+
+- #76 Added wrapper for Python ipaddress methods for use with Jinja
+
+### Fixed
+
+- #75 Updated Python requirements to be loosened
+- #76 Fixed doc errors with ip methods
+- #77 Fixed CI pipeline for docker caching
+
 ## v0.2.4 - 2021-11
 
 ### Added

diff --git a/README.md b/README.md
@@ -143,21 +143,22 @@ Relevant PR's
 # Contributing
 
 Pull requests are welcomed and automatically built and tested against multiple versions of Python through TravisCI.
+Except for unit tests, testing is only supported on Python 3.7.
 
 The project is packaged with a light development environment based on `docker-compose` to help with the local development of the project and to run tests within TravisCI.
 
 The project is following Network to Code software development guidelines and are leveraging the following:
 - Black, Pylint, Bandit, flake8, and pydocstyle for Python linting and formatting.
 - pytest, coverage, and unittest for unit tests.
 
-There are a number of things that are required in order to have a successfull PR.
+There are a number of things that are required in order to have a successful PR.
 
 - All new functions must contain at least 1 example in their docstrings.
 - Docstrings must conform to the google docstring [convention](https://google.github.io/styleguide/pyguide.html#381-docstrings).
 - Unit test for newly added functions are required.
 - If applicable, tests related to config parsing and compliuance must be added.
-- Update the jinja2 filter for any new functions (see below for details).
-- If you create a new file in the `netutils` folder, you must create a new folder and `index.rst` in the docs folde r(see below for details).
+- Update the jinja2 filter (netutils.utils.jinja2_convenience_function) for any new functions (see below for details).
+- If you create a new file in the `netutils` folder, you must create a new folder and `index.rst` in the docs folder (see below for details).
 - Your PR must not introduce any required dependencies. You can introduce optional or development dependencies.
 
 ## Adding to the jinja2 filter function

diff --git a/docs/source/contributing/index.rst b/docs/source/contributing/index.rst
@@ -3,5 +3,5 @@ Contributing
 ############
 
 .. mdinclude:: ../../../README.md
-   :start-line: 144
-   :end-line: 228
+   :start-line: 145
+   :end-line: 229