updates fork

.github/workflows/build.yml

@@ -0,0 +1,52 @@
+name: build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "pypy-3.8"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: pip
+        cache-dependency-path: setup.cfg
+        check-latest: true
+    - name: Install dependencies
+      run: python -m pip install --upgrade pip tox tox-gh-actions
+    - name: Run tests
+      run: tox
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+      - uses: pre-commit/[email protected]
+
+  docs:
+    name: docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+
+      - run: pip install tox
+
+      - name: Run docs tox job
+        run: tox -e docs

.github/workflows/release.yml

@@ -0,0 +1,21 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+    - name: Install tox
+      run: python3 -m pip install --upgrade tox
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m tox -e build
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_TOKEN }}

.gitignore

@@ -6,7 +6,7 @@ dist/
 downloads
 eggs
 parts
-src/*.egg-info
+*.egg-info
 build/
 .ropeproject
 .tox
@@ -16,3 +16,5 @@ build/
 .settings
 .python-version
 .idea/
+docs/_build
+.cache

.pre-commit-config.yaml

@@ -0,0 +1,63 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: "24.4.0"
+    hooks:
+      - id: black
+        args:
+          - --quiet
+
+  - repo: https://github.com/pycqa/isort
+    rev: "5.13.2"
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: "v3.15.2"
+    hooks:
+      - id: pyupgrade
+        args:
+          - --py3-plus
+          - --py36-plus
+          - --py37-plus
+          - --py38-plus
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.6.0"
+    hooks:
+      - id: check-ast
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+
+  - repo: https://github.com/sirosen/check-jsonschema
+    rev: "0.28.2"
+    hooks:
+      - id: check-github-workflows
+        require_serial: true
+
+  - repo: https://github.com/pycqa/flake8
+    rev: "7.0.0"
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-type-checking
+          - flake8-bugbear
+          - flake8-comprehensions
+          - flake8-print
+          - flake8-mutable
+          - flake8-simplify
+          - flake8-pytest-style
+          - flake8-printf-formatting
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.9.0"
+    hooks:
+      - id: mypy
+        exclude: ^(docs/|setup.py$)
+        additional_dependencies:
+          - pytest
+
+  - repo: https://github.com/mgedmin/check-manifest
+    rev: "0.49"
+    hooks:
+      - id: check-manifest

.readthedocs.yml

@@ -0,0 +1,3 @@
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py

CHANGES.rst

@@ -4,11 +4,140 @@
 
 Significant or incompatible changes listed here.
 
+Unreleased - TBA
+----------------
+* Added support for Python 3.12
+* Removed support for Python 3.7
 
-Changes in v0.7
----------------
+3.0 (2022-11-27)
+----------------
+* Added ``SLE`` & ``VED`` currencies.
+* Removed support for Python 3.6.
+* Added support for Python 3.10 & 3.11.
+
+2.0 (2021-05-26)
+----------------
+* Dropped support for Python 2.7 and 3.5 and PyPy 2.
+* Added pyupgrade pre-commit hook.
+* Added black pre-commit hook and reformatted codebase.
+* Updated pre-commit hooks.
+* Replaced custom flake8, isort and check-manifest Github Action jobs with a generic
+  pre-commit job.
+* Dropped the ``moneyed.localization`` module that was deprecated and announced for
+  removal in 1.0.
+* Added type hints along with a mypy pre-commit hook.
+* Added action for building and publishing releases, along with the
+  check-github-workflows pre-commit hook for validating Github Action workflow files.
+* Removed undocumented ``DEFAULT_CURRENCY`` and ``DEFAULT_CURRENCY_CODE`` constants, and
+  change to make instantiating ``Money`` without providing a currency a type error. This
+  used to result in an object with a made-up ``"XYZ"`` currency, which could lead to
+  surprising behaviors and bugs.
+* Added ``zero`` property to ``Currency`` to conveniently access the zero value of a
+  given currency.
+* Moved to use setuptool's declarative packaging config and PEP 517 isolated builds.
+* Removed requirements files and instead specified test requirements using extras.
+
+1.2 (2021-02-23)
+----------------
+* ``Money.__add__`` returns ``NotImplemented`` instead of raising an exception when another operand has unsupported type.
+
+1.1 (2021-01-15)
+----------------
+* Changed the ``numeric`` attribute values to ``None`` for currencies that don't have assigned ISO numeric codes: ``IMP``, ``TVD``, ``XFO``, ``XFU``.
+* Restored the previous definition for the ``XXX`` currency, including its ``name`` and ``countries`` attributes.
+* Fixed ``get_currency`` returning obsolete currencies.
+
+1.0 (2021-01-09)
+----------------
+* Dropped official support for Python 2.6, 3.2, 3.3, 3.4 (mainly because
+  our test tools don't support them any more).
+
+* Added support for getting amount in sub units (fixed point)
+
+* Format ``Money`` instances using CLDR and Babel. This is a large change with lots of parts.
+  Many thanks to @pooyamb for all the hard work that went into this and other
+  related changes.
+
+  * Added new ``moneyed.l10n`` module, containing a new ``format_money``
+    function. This is a very thin wrapper around `babel.numbers.format_currency
+    <http://babel.pocoo.org/en/latest/api/numbers.html#babel.numbers.format_currency>`_
+    and has all the same options. This allows us to get the official CLDR
+    formats for currencies, in all the different locales.
+
+    See docs in README.
+
+    Note especially that you need to specify ``locale`` (e.g.
+    ``locale="en_US"``), or you will get the ``LC_NUMERIC`` default.
+
+  * Deprecated the ``format_money`` function in ``moneyed.localization``. There
+    is no immediate plan to remove, but it should not be relied on. Also, this
+    function relies on our own manually entered data for formatting of
+    currencies in different locales. This data is very incomplete and will not
+    be updated any more.
+
+    So you need to use ``moneyed.l10n.format_money`` instead now.
+
+    If you were relying on the ``decimal_places`` argument to the old function,
+    there is no exact equivalent in the new ``format_money`` function, but see
+    the ``decimal_quantization`` option (documented in
+    `babel.numbers.format_currency
+    <http://babel.pocoo.org/en/latest/api/numbers.html#babel.numbers.format_currency>`_)
+
+  * ``Money.__str__`` (``Money.__unicode__`` on Python 2) now uses new
+    ``format_money`` with the default locale ``LC_NUMERIC``, which can produce
+    different results from the old function. Use the new ``format_money`` to control
+    output.
+
+  * On Python 2, ``Money.__str__`` (bytestring) output has changed to be more
+    basic. You should use the new ``format_money`` function to control output.
 
-* Money.__str__ changed under Python 2 to use only ASCII characters.
+* Get currency names from Babel data. Several changes, including:
+
+  * For all built-in currencies, ``Currency.name`` now comes from Babel ("en_US"
+    locale). This means there have been various corrections to currency names.
+
+    If you pass a non-None ``name`` to the ``Currency`` constructor, you can
+    still specify any name you want.
+
+  * ``Currency.get_name(locale)`` has been added.
+
+* Get currency 'countries' from Babel data. Several changes, including:
+
+  * ``Currency.countries`` now sources from Babel, so some names may be different.
+
+  * ``Currency.country_codes`` has been added.
+
+  * ``Currency.countries`` is deprecated, because it is not the most useful form
+    for the data (e.g. upper cased strings, and names in US English only). It is
+    recommended to use ``Currency.country_codes`` and convert to names using
+    ``get_country_name``.
+
+* Changed the repr of ``Money`` so that ``eval(repr(money_object) ==
+  money_object`` (at least in some environments, and most of the typical ones).
+  See `Python docs on __repr__
+  <https://docs.python.org/3/reference/datamodel.html?highlight=__repr__#object.__repr__>`_
+  for rationale. Thanks `@davidtvs <https://github.com/davidtvs>`_. This could
+  be backwards incompatible if you were relying on the old output of ``repr()``.
+
+* Added ``list_all_currencies()`` utility function.
+
+0.8 (2018-11-19)
+----------------
+
+* ``Money.round([ndigits])`` added.
+  Uses ``decimal.ROUND_HALF_EVEN`` by default, but this can be overridden
+  by setting ``rounding`` in the ``decimal`` context before calling ``Money.round()``.
+* Various fixes/additions for different locales
+* Division support on Python 2
+* DEFAULT locale is now used as a fallback to return a currency symbol if your
+  chosen locale has no symbol set for that currency, rather than just returning
+  the currency code.
+
+
+0.7 (2017-05-08)
+----------------
+
+* ``Money.__str__`` changed under Python 2 to use only ASCII characters.
   This means that currency codes, rather than symbols, are used.
 
 * Lots of additional locales supported out of the box.
@@ -21,7 +150,7 @@ Changes in v0.7
 * Various other bug fixes
 
 
-Changes in v0.6 and earlier
----------------------------
+0.6 and earlier
+---------------
 
 * See VCS logs.

CONTRIBUTING.rst

@@ -0,0 +1,56 @@
+Contributing to py-moneyed
+==========================
+
+If you would like to contribute to py-moneyed, the recommended workflow is:
+
+1. First raise an issue on GitHub for any proposal or idea that might be
+   controversial and get feedback from the maintainers. If you have something
+   that is an obvious bug (a typo in the docs, for example), you can skip this
+   step.
+
+2. Fork the project and checkout your fork onto your development machine.
+
+3. Create a virtualenv of some kind for development (venv_, virtualenv_ or
+   virtualenvwrapper_) and install py-moneyed into it::
+
+     python setup.py develop
+
+4. Optional, but highly recommended to save time later - install `pre-commit
+   <https://pre-commit.com/>`_ hooks::
+
+     pip install pre-commit
+     pre-commit install
+
+5. Create a git branch for your changes, starting from ``master``
+
+6. Fix the bug or implement your changes, being sure to:
+
+   1. Add tests and docs
+   2. Run the test suite (below)
+
+7. Push your changes to your GitHub repo and submit a pull request.
+
+Testing
+-------
+
+To run the test suite, first install tox (into your virtualenv)::
+
+  pip install tox
+
+Run the tests using tox::
+
+  tox -e py310
+
+You can run the test suite on all supported environments using tox_
+(recommended). If you do not have all versions of Python that are used in
+testing, you can use pyenv_ to install them, and you may benefit from the
+additional plugin pyenv-implict_.
+
+The py-moneyed package is tested against Python 3.7 - 3.11 and PyPy 3.
+
+.. _tox: https://tox.readthedocs.io/en/latest/
+.. _pyenv: https://github.com/pyenv/pyenv
+.. _pyenv-implict: https://github.com/concordusapps/pyenv-implict
+.. _venv: https://docs.python.org/3/library/venv.html
+.. _virtualenv: https://virtualenv.pypa.io/en/stable/
+.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/

CONTRIBUTORS

@@ -5,4 +5,4 @@ Jacob Hansson ([email protected]) contributed a better currency
 formatting implementation, and various patches, in May 2011.
 
 Wojciech Banas added compatibility with multiple versions of Python,
-including Python 3.x, in August 2013.
+including Python 3.x, in August 2013.