Book abbreviations (#95)

* initial changelog

* move regular expressions and titles inside enums as properties

* updated documentation

* doc config tidying up

* updated documentation with jupyter notebooks

* prep CHANGELOG for 0.10.0 release

* tidied up flit info

Author: avendesora

.sourcery.yaml

@@ -9,6 +9,7 @@ ignore:
     - vendor
     - pythonbible/bible/asv/*.py
     - pythonbible/bible/kjv/*.py
+    - docs/build
 
 rule_settings:
-  python_version: '3.7'
+  python_version: 3.7

CHANGELOG.md

@@ -0,0 +1,125 @@
+# Changelog
+
+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).
+
+## [Unreleased]
+
+## [0.10.0]
+
+The goal of this release was to address [Issue #90], and to make things related to Books, BookGroups, and Versions structured in a more object-oriented way.
+
+### Added
+
+- started this Changlog
+- new abbreviations list property of Book Enum
+- Jupyter notebook for Basic Usage documentation
+- Jupyter notebook for Advanced Usage, Single Chapter Books documentation
+- Jupyter notebook for Advanced Usage, Multi Book References documentation
+- Jupyter notebook for Advanced Usage, Book Groups documentation
+
+### Changed
+
+- moved book specific regular expressions to new regular_expression property of Book
+- moved book default titles to be encapsulated within the Book Enum and updated the title property to use them
+- moved book group regular expressions to be encapsulated within the BookGroup Enum and updated the regular_expression property to use them
+- moved book group books tuple to be encapsulated within the BookGroup Enum and updated the books property to use them
+- moved version titles to be encapsulated within the Version Enum and updated the title property to use them
+- updated Technical Reference documentation to use autodocs (generate documentation from docstrings)
+
+### Fixed
+
+- changed the default Version to AMERICAN_STANDARD in order to match the existing documentation
+- updated Advanced Usage documentation to reference the format_scripture_references function rather than the format_references function (which doesn't exist)
+- fixed a typo on the documentation index page
+
+## [0.9.1] - 2023-05-09
+
+## [0.9.0] - 2023-05-09
+
+## [0.8.0] - 2023-04-27
+
+## [0.7.4] - 2022-07-15
+
+## [0.7.3] - 2022-07-14
+
+## [0.7.2] - 2022-06-27
+
+## [0.7.1] - 2022-06-23
+
+## [0.7.0] - 2022-04-29
+
+## [0.6.1] - 2021-09-28
+
+## [0.6.0] - 2021-09-28
+
+## [0.5.0] - 2021-06-09
+
+## [0.4.1] - 2021-05-04
+
+## [0.4.0] - 2021-05-03
+
+## [0.3.1] - 2021-02-25
+
+## [0.3.0] - 2021-02-10
+
+## [0.2.2] - 2020-11-30
+
+## [0.2.1] - 2020-11-20
+
+## [0.2.0] - 2010-11-18
+
+## [0.1.5] - 2020-11-02
+
+## [0.1.4] - 2020-10-29
+
+## [0.1.3] - 2020-10-27
+
+## [0.1.2] - 2020-10-27
+
+## [0.1.1] - 2020-10-20
+
+## [0.1.0] - 2020-10-19
+
+## [0.0.4] - 2020-10-15
+
+## [0.0.3] - 2020-10-10
+
+## [0.0.2] - 2020-10-08
+
+## [0.0.1] - 2020-10-08
+
+[unreleased]: https://github.com/avendesora/pythonbible/compare/v0.10.0...HEAD
+[0.10.0]: https://github.com/avendesora/pythonbible/compare/v0.9.1...v0.10.0
+[0.9.1]: https://github.com/avendesora/pythonbible/compare/v0.9.0...v0.9.1
+[0.9.0]: https://github.com/avendesora/pythonbible
+[0.8.0]: https://github.com/avendesora/pythonbible
+[0.7.4]: https://github.com/avendesora/pythonbible
+[0.7.3]: https://github.com/avendesora/pythonbible
+[0.7.2]: https://github.com/avendesora/pythonbible
+[0.7.1]: https://github.com/avendesora/pythonbible
+[0.7.0]: https://github.com/avendesora/pythonbible
+[0.6.1]: https://github.com/avendesora/pythonbible
+[0.6.0]: https://github.com/avendesora/pythonbible
+[0.5.0]: https://github.com/avendesora/pythonbible
+[0.4.1]: https://github.com/avendesora/pythonbible
+[0.4.0]: https://github.com/avendesora/pythonbible
+[0.3.1]: https://github.com/avendesora/pythonbible
+[0.3.0]: https://github.com/avendesora/pythonbible
+[0.2.2]: https://github.com/avendesora/pythonbible
+[0.2.1]: https://github.com/avendesora/pythonbible
+[0.2.0]: https://github.com/avendesora/pythonbible
+[0.1.5]: https://github.com/avendesora/pythonbible
+[0.1.4]: https://github.com/avendesora/pythonbible
+[0.1.3]: https://github.com/avendesora/pythonbible
+[0.1.2]: https://github.com/avendesora/pythonbible
+[0.1.1]: https://github.com/avendesora/pythonbible
+[0.1.0]: https://github.com/avendesora/pythonbible
+[0.0.4]: https://github.com/avendesora/pythonbible
+[0.0.3]: https://github.com/avendesora/pythonbible
+[0.0.2]: https://github.com/avendesora/pythonbible
+[0.0.1]: https://github.com/avendesora/pythonbible
+
+[issue #90]: https://github.com/avendesora/pythonbible/issues/90

README.md

@@ -43,7 +43,7 @@ The full documentation for pythonbible can be found at [docs.python.bible](https
 ## Installation
 
 ```shell script
-pip install pythonbible
+python3 -m pip install pythonbible
 ```
 
 ## Features