🔖 Version 1.0.0

ottowayi · Mar 10, 2021 · 17e02c8 · 17e02c8
1 parent ffee557
commit 17e02c8
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 3 deletions.
diff --git a/docs/releases.rst b/docs/releases.rst
@@ -0,0 +1,29 @@
+===============
+Release History
+===============
+
+1.0.0
+=====
+
+- |:sparkles:| New type system to replace the ``Pack`` and ``Unpack`` helper classes
+    - New types represent any CIP type or object and allow encoding and decoding of values
+    - Allows users to create their own custom types
+    - |:boom:| **[Breaking]** ``generic_message`` replaced the ``data_format`` argument with ``data_type``, see documentation for details.
+- |:sparkles:| Added a new ``discover()`` method for finding Ethernet/IP devices on the local network
+- |:sparkles:| Added a ``configure_default_logger`` method for simple logging setup
+    - Packet contents are now logged using a custom ``VERBOSE`` level
+- |:art:| Internal package structure changed.
+- |:recycle:| Lots of refactoring, decoupling, etc
+- |:white_check_mark:| Increased test coverage
+- |:memo:| New and improved documentation
+    - |:construction:| Still a work-in-progress
+
+
+Logix Driver
+^^^^^^^^^^^^
+
+- |:triangular_flag_on_post:| Upload of program-scoped tags is now enabled by default
+    - Use ``init_program_tags=False`` in initializer for to upload controller-scoped only tags
+- |:boom:| Removed the ``init_info`` and ``micro800`` init args and the ``use_instance_ids`` property
+    - These have all been automatic for awhile now, but were left for backwards compatibility
+    - If you need to customize this behavior, override the ``_initialize_driver`` method
diff --git a/pycomm3/_version.py b/pycomm3/_version.py
@@ -22,5 +22,5 @@
 # SOFTWARE.
 #
 
-__version_info__ = (1, 0, 0, 'b1')
+__version_info__ = (1, 0, 0)
 __version__ = '.'.join(f'{x}' for x in __version_info__)
diff --git a/pycomm3/packets/logix.py b/pycomm3/packets/logix.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (c) 2020 Ian Ottoway <[email protected]>
+# Copyright (c) 2021 Ian Ottoway <[email protected]>
 # Copyright (c) 2014 Agostino Ruscito <[email protected]>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

diff --git a/pycomm3/packets/util.py b/pycomm3/packets/util.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (c) 2020 Ian Ottoway <[email protected]>
+# Copyright (c) 2021 Ian Ottoway <[email protected]>
 # Copyright (c) 2014 Agostino Ruscito <[email protected]>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy