Merge pull request #83 from remix/prepare-v1.1.2

Prepare v1.1.2 release

HISTORY.rst

@@ -2,6 +2,22 @@
 History
 =======
 
+1.1.2 (2022-11-23)
+------------------
+
+Code changes:
+
+* Remove references to deprecated NumPy types (https://github.com/remix/partridge/pull/69 - thanks @BlackSpade741!)
+* Switch from `cChardet <https://github.com/PyYoshi/cChardet>`_ to `charset-normalizer <https://github.com/Ousret/charset_normalizer>`_ for Python 3.10 support (https://github.com/remix/partridge/pull/76 - thanks @brockhaywood!)
+
+Other changes:
+
+* Miscellaneous improvements to tests, code formatting, and documentation (https://github.com/remix/partridge/pull/61 - thanks @invisiblefunnel!)
+* Relocate usage examples from wiki to README (https://github.com/remix/partridge/pull/70 - thanks @landonreed!)
+* README tweaks (https://github.com/remix/partridge/pull/74 - thanks @chelsey!)
+* Use GitHub Actions for automated testing (https://github.com/remix/partridge/pull/79 - thanks @dget!). **Note:** we now test against Python versions 3.8, 3.9, 3.10, and 3.11.
+
+
 1.1.1 (2019-09-13)
 ------------------
 

README.rst

@@ -23,7 +23,7 @@ Feeds can also be filtered to create a view specific to your needs. It's most co
 
 
 Philosophy
----------
+----------
 
 The design of Partridge is guided by the following principles:
 

RELEASING.rst

@@ -0,0 +1,49 @@
+========================
+Publishing a new release
+========================
+
+Based on https://packaging.python.org/en/latest/tutorials/packaging-projects
+
+Prerequisites
+~~~~~~~~~~~~~
+
+* Update ``HISTORY.rst``
+* Tag Git release, e.g.::
+
+    $ git tag v1.2.3
+    $ git push --tags
+
+* If needed, create an account on TestPyPI: https://test.pypi.org/account/register/
+* Generate a test API token: https://test.pypi.org/manage/account/token/
+* Generate a real API token: https://pypi.org/manage/account/token/
+* Install deployment tools::
+
+    $ pip install --upgrade build twine
+
+Process
+~~~~~~~
+
+* Build the package::
+
+    $ python -m build
+
+* Check package validity (optional)::
+
+    $ python -m twine check dist/*
+
+* Upload the package to TestPyPI (username is ``__token__``, password is your API token)::
+
+    $ python -m twine upload --repository testpypi dist/*
+
+* Verify the test release can be installed::
+
+    $ python -m venv testing
+    $ testing/bin/pip install --index-url https://test.pypi.org/simple/ --no-deps partridge==<VERSION>
+
+  Note: we use ``--no-deps`` because not all dependencies are present in
+  TestPyPI. For more comprehensive testing, manually install deps from the real
+  PyPI.
+
+* Upload the package to PyPI (username is ``__token__``, password is your API token)::
+
+    $ python -m twine upload dist/*

partridge/__version__.py

@@ -1 +1 @@
-__version__ = "1.1.1"
+__version__ = "1.1.2"