Improvements to pagesizes, and added new features

Author: domdfcoding

.readthedocs.yml

@@ -17,4 +17,5 @@ formats: all
 python:
   version: 3.6
   install:
+    - requirements: requirements.txt
     - requirements: doc-source/requirements.txt

MANIFEST.in

@@ -1,3 +1,4 @@
 include __pkginfo__.py
 include LICENSE
+include requirements.txt
 recursive-exclude **/__pycache__ *

__pkginfo__.py

@@ -44,8 +44,8 @@
 repo_root = pathlib.Path(__file__).parent
 
 # Get info from files; set: long_description
-install_requires = []
 long_description = (repo_root / "README.rst").read_text() + '\n'
+install_requires = (repo_root / "requirements.txt").read_text().split('\n')
 extras_require = {"dates": ["pytz>=2019.1"]}
 
 classifiers = [

doc-source/conf.py

@@ -40,6 +40,7 @@
 		]
 
 templates_path = ['_templates']
+html_static_path = ['_static']
 source_suffix = '.rst'
 exclude_patterns = []
 

doc-source/requirements.txt

@@ -1,2 +1,3 @@
 sphinxcontrib-httpdomain
 sphinx
+pytz >= 2019.1

domdf_python_tools/bases.py

@@ -0,0 +1,100 @@
+#  !/usr/bin/env python
+#   -*- coding: utf-8 -*-
+#
+#  bases.py
+"""
+Useful base classes
+"""
+#
+#  Copyright © 2020 Dominic Davis-Foster <[email protected]>
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation; either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+#  MA 02110-1301, USA.
+#
+
+
+
+# stdlib
+from abc import ABC, abstractmethod
+from collections import UserList
+from pprint import pformat
+
+# 3rd party
+import pydash
+
+
+class Dictable(ABC):
+	"""
+	The basic structure of a class than can be converted into a dictionary
+	"""
+	
+	@abstractmethod
+	def __init__(self, *args, **kwargs):
+		pass
+	
+	def __str__(self):
+		return self.__repr__()
+	
+	def __iter__(self):
+		for key, value in self.__dict__().items():
+			yield key, value
+	
+	def __getstate__(self):
+		return self.__dict__()
+	
+	def __setstate__(self, state):
+		self.__init__(**state)
+	
+	def __copy__(self):
+		return self.__class__(**self.__dict__())
+	
+	def __deepcopy__(self, memodict={}):
+		return self.__copy__()
+	
+	@abstractmethod
+	def __dict__(self):
+		return dict()
+	
+	def __eq__(self, other):
+		if isinstance(other, self.__class__):
+			return pydash.predicates.is_match(other.__dict__(), self.__dict__())
+		
+		return NotImplemented
+
+
+def namedlist(name="NamedList"):
+	"""
+	A factory function to return a custom list subclass with a name
+
+	:param name:
+	:type name:
+	:return:
+	:rtype:
+	"""
+	
+	class NamedList(UserList):
+		"""
+		A list with a name
+		"""
+		
+		def __repr__(self):
+			return f"{super().__repr__()}"
+		
+		def __str__(self):
+			return f"{self.__class__.__name__}{pformat(list(self))}"
+	
+	NamedList.__name__ = name
+	
+	return NamedList

domdf_python_tools/doctools.py

@@ -85,7 +85,7 @@ def append_doctring_from_another(target, original):
 
 
 def make_sphinx_links(input_string, builtins_list=None):
-	"""
+	r"""
 	Make proper sphinx links out of double-backticked strings in docstring.
 
 	i.e. \`\`str\`\` becomes \:class\:\`~python:str\`
@@ -148,7 +148,7 @@ def wrapper(target):
 
 
 def sphinxify_docstring():
-	"""
+	r"""
 	Make proper sphinx links out of double-backticked strings in docstring.
 
 	i.e. \`\`str\`\` becomes \:class\:\`~python:str\`

domdf_python_tools/enums.py

@@ -0,0 +1,63 @@
+#  !/usr/bin/env python
+#   -*- coding: utf-8 -*-
+#
+#  enums.py
+"""
+Enum subclasses with some extra features
+"""
+#
+#  Copyright © 2020 Dominic Davis-Foster <[email protected]>
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation; either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+#  MA 02110-1301, USA.
+#
+
+from enum import Enum
+
+__all__ = ["IntEnum", "StrEnum"]
+
+
+class IntEnum(Enum):
+	"""
+	An Enum that can be converted into an integer
+	"""
+	
+	def __int__(self):
+		return self.value
+	
+	def __eq__(self, other):
+		if int(self) == other:
+			return True
+		else:
+			return super().__eq__(other)
+
+
+class StrEnum(Enum):
+	"""
+	An Enum that can be converted into a string
+	"""
+	
+	def __str__(self):
+		return self.value
+	
+	def __repr__(self):
+		return self.value
+	
+	def __eq__(self, other):
+		if str(self) == other:
+			return True
+		else:
+			return super().__eq__(other)
+