Metadata-Version: 2.1
Name: deprecation-alias
Version: 0.3.2
Summary: A wrapper around 'deprecation' providing support for deprecated aliases.
Home-page: https://github.com/domdfcoding/deprecation-alias
Author: Dominic Davis-Foster
Author-email: Dominic Davis-Foster <dominic@davis-foster.co.uk>
License: Apache License
        Version 2.0, January 2004
        http://www.apache.org/licenses/
        
        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
        1. Definitions.
        
            "License" shall mean the terms and conditions for use, reproduction, and
            distribution as defined by Sections 1 through 9 of this document.
        
            "Licensor" shall mean the copyright owner or entity authorized by the
            copyright owner that is granting the License.
        
            "Legal Entity" shall mean the union of the acting entity and all other
            entities that control, are controlled by, or are under common control with
            that entity. For the purposes of this definition, "control" means (i) the
            power, direct or indirect, to cause the direction or management of such
            entity, whether by contract or otherwise, or (ii) ownership of
            fifty percent (50%) or more of the outstanding shares, or (iii) beneficial
            ownership of such entity.
        
            "You" (or "Your") shall mean an individual or Legal Entity exercising
            permissions granted by this License.
        
            "Source" form shall mean the preferred form for making modifications,
            including but not limited to software source code, documentation source,
            and configuration files.
        
            "Object" form shall mean any form resulting from mechanical transformation
            or translation of a Source form, including but not limited to compiled
            object code, generated documentation, and conversions to
            other media types.
        
            "Work" shall mean the work of authorship, whether in Source or Object
            form, made available under the License, as indicated by a copyright notice
            that is included in or attached to the work (an example is provided in the
            Appendix below).
        
            "Derivative Works" shall mean any work, whether in Source or Object form,
            that is based on (or derived from) the Work and for which the editorial
            revisions, annotations, elaborations, or other modifications represent,
            as a whole, an original work of authorship. For the purposes of this
            License, Derivative Works shall not include works that remain separable
            from, or merely link (or bind by name) to the interfaces of, the Work and
            Derivative Works thereof.
        
            "Contribution" shall mean any work of authorship, including the original
            version of the Work and any modifications or additions to that Work or
            Derivative Works thereof, that is intentionally submitted to Licensor for
            inclusion in the Work by the copyright owner or by an individual or
            Legal Entity authorized to submit on behalf of the copyright owner.
            For the purposes of this definition, "submitted" means any form of
            electronic, verbal, or written communication sent to the Licensor or its
            representatives, including but not limited to communication on electronic
            mailing lists, source code control systems, and issue tracking systems
            that are managed by, or on behalf of, the Licensor for the purpose of
            discussing and improving the Work, but excluding communication that is
            conspicuously marked or otherwise designated in writing by the copyright
            owner as "Not a Contribution."
        
            "Contributor" shall mean Licensor and any individual or Legal Entity on
            behalf of whom a Contribution has been received by Licensor and
            subsequently incorporated within the Work.
        
        2. Grant of Copyright License.
        
            Subject to the terms and conditions of this License, each Contributor
            hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
            royalty-free, irrevocable copyright license to reproduce, prepare
            Derivative Works of, publicly display, publicly perform, sublicense,
            and distribute the Work and such Derivative Works in
            Source or Object form.
        
        3. Grant of Patent License.
        
            Subject to the terms and conditions of this License, each Contributor
            hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
            royalty-free, irrevocable (except as stated in this section) patent
            license to make, have made, use, offer to sell, sell, import, and
            otherwise transfer the Work, where such license applies only to those
            patent claims licensable by such Contributor that are necessarily
            infringed by their Contribution(s) alone or by combination of their
            Contribution(s) with the Work to which such Contribution(s) was submitted.
            If You institute patent litigation against any entity (including a
            cross-claim or counterclaim in a lawsuit) alleging that the Work or a
            Contribution incorporated within the Work constitutes direct or
            contributory patent infringement, then any patent licenses granted to
            You under this License for that Work shall terminate as of the date such
            litigation is filed.
        
        4. Redistribution.
        
            You may reproduce and distribute copies of the Work or Derivative Works
            thereof in any medium, with or without modifications, and in Source or
            Object form, provided that You meet the following conditions:
        
            1. You must give any other recipients of the Work or Derivative Works a
            copy of this License; and
        
            2. You must cause any modified files to carry prominent notices stating
            that You changed the files; and
        
            3. You must retain, in the Source form of any Derivative Works that You
            distribute, all copyright, patent, trademark, and attribution notices from
            the Source form of the Work, excluding those notices that do not pertain
            to any part of the Derivative Works; and
        
            4. If the Work includes a "NOTICE" text file as part of its distribution,
            then any Derivative Works that You distribute must include a readable copy
            of the attribution notices contained within such NOTICE file, excluding
            those notices that do not pertain to any part of the Derivative Works,
            in at least one of the following places: within a NOTICE text file
            distributed as part of the Derivative Works; within the Source form or
            documentation, if provided along with the Derivative Works; or, within a
            display generated by the Derivative Works, if and wherever such
            third-party notices normally appear. The contents of the NOTICE file are
            for informational purposes only and do not modify the License.
            You may add Your own attribution notices within Derivative Works that You
            distribute, alongside or as an addendum to the NOTICE text from the Work,
            provided that such additional attribution notices cannot be construed
            as modifying the License.
        
            You may add Your own copyright statement to Your modifications and may
            provide additional or different license terms and conditions for use,
            reproduction, or distribution of Your modifications, or for any such
            Derivative Works as a whole, provided Your use, reproduction, and
            distribution of the Work otherwise complies with the conditions
            stated in this License.
        
        5. Submission of Contributions.
        
            Unless You explicitly state otherwise, any Contribution intentionally
            submitted for inclusion in the Work by You to the Licensor shall be under
            the terms and conditions of this License, without any additional
            terms or conditions. Notwithstanding the above, nothing herein shall
            supersede or modify the terms of any separate license agreement you may
            have executed with Licensor regarding such Contributions.
        
        6. Trademarks.
        
            This License does not grant permission to use the trade names, trademarks,
            service marks, or product names of the Licensor, except as required for
            reasonable and customary use in describing the origin of the Work and
            reproducing the content of the NOTICE file.
        
        7. Disclaimer of Warranty.
        
            Unless required by applicable law or agreed to in writing, Licensor
            provides the Work (and each Contributor provides its Contributions)
            on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
            either express or implied, including, without limitation, any warranties
            or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS
            FOR A PARTICULAR PURPOSE. You are solely responsible for determining the
            appropriateness of using or redistributing the Work and assume any risks
            associated with Your exercise of permissions under this License.
        
        8. Limitation of Liability.
        
            In no event and under no legal theory, whether in tort
            (including negligence), contract, or otherwise, unless required by
            applicable law (such as deliberate and grossly negligent acts) or agreed
            to in writing, shall any Contributor be liable to You for damages,
            including any direct, indirect, special, incidental, or consequential
            damages of any character arising as a result of this License or out of
            the use or inability to use the Work (including but not limited to damages
            for loss of goodwill, work stoppage, computer failure or malfunction,
            or any and all other commercial damages or losses), even if such
            Contributor has been advised of the possibility of such damages.
        
        9. Accepting Warranty or Additional Liability.
        
            While redistributing the Work or Derivative Works thereof, You may choose
            to offer, and charge a fee for, acceptance of support, warranty,
            indemnity, or other liability obligations and/or rights consistent with
            this License. However, in accepting such obligations, You may act only
            on Your own behalf and on Your sole responsibility, not on behalf of any
            other Contributor, and only if You agree to indemnify, defend, and hold
            each Contributor harmless for any liability incurred by, or claims
            asserted against, such Contributor by reason of your accepting any such
            warranty or additional liability.
        
        END OF TERMS AND CONDITIONS
        
        APPENDIX: How to apply the Apache License to your work
        
            To apply the Apache License to your work, attach the following boilerplate
            notice, with the fields enclosed by brackets "[]" replaced with your own
            identifying information. (Don't include the brackets!) The text should be
            enclosed in the appropriate comment syntax for the file format. We also
            recommend that a file or class name and description of purpose be included
            on the same "printed page" as the copyright notice for easier
            identification within third-party archives.
        
                Copyright 2020 Dominic Davis-Foster
        
                Licensed under the Apache License, Version 2.0 (the "License");
                you may not use this file except in compliance with the License.
                You may obtain a copy of the License at
        
                http://www.apache.org/licenses/LICENSE-2.0
        
                Unless required by applicable law or agreed to in writing, software
                distributed under the License is distributed on an "AS IS" BASIS,
                WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
                or implied. See the License for the specific language governing
                permissions and limitations under the License.
        
Project-URL: Homepage, https://github.com/domdfcoding/deprecation-alias
Project-URL: Issue Tracker, https://github.com/domdfcoding/deprecation-alias/issues
Project-URL: Source Code, https://github.com/domdfcoding/deprecation-alias
Keywords: deprecation
Platform: Windows
Platform: macOS
Platform: Linux
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.6.1
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: deprecation>=2.1.0
Requires-Dist: packaging>=20.4

##################
deprecation-alias
##################

.. start short_desc

**A wrapper around 'deprecation' providing support for deprecated aliases.**

.. end short_desc


.. start shields

.. list-table::
	:stub-columns: 1
	:widths: 10 90

	* - Tests
	  - |actions_linux| |actions_windows| |actions_macos| |coveralls|
	* - PyPI
	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
	* - Anaconda
	  - |conda-version| |conda-platform|
	* - Activity
	  - |commits-latest| |commits-since| |maintained| |pypi-downloads|
	* - QA
	  - |codefactor| |actions_flake8| |actions_mypy|
	* - Other
	  - |license| |language| |requires|

.. |actions_linux| image:: https://github.com/domdfcoding/deprecation-alias/workflows/Linux/badge.svg
	:target: https://github.com/domdfcoding/deprecation-alias/actions?query=workflow%3A%22Linux%22
	:alt: Linux Test Status

.. |actions_windows| image:: https://github.com/domdfcoding/deprecation-alias/workflows/Windows/badge.svg
	:target: https://github.com/domdfcoding/deprecation-alias/actions?query=workflow%3A%22Windows%22
	:alt: Windows Test Status

.. |actions_macos| image:: https://github.com/domdfcoding/deprecation-alias/workflows/macOS/badge.svg
	:target: https://github.com/domdfcoding/deprecation-alias/actions?query=workflow%3A%22macOS%22
	:alt: macOS Test Status

.. |actions_flake8| image:: https://github.com/domdfcoding/deprecation-alias/workflows/Flake8/badge.svg
	:target: https://github.com/domdfcoding/deprecation-alias/actions?query=workflow%3A%22Flake8%22
	:alt: Flake8 Status

.. |actions_mypy| image:: https://github.com/domdfcoding/deprecation-alias/workflows/mypy/badge.svg
	:target: https://github.com/domdfcoding/deprecation-alias/actions?query=workflow%3A%22mypy%22
	:alt: mypy status

.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/deprecation-alias/badge.svg
	:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/deprecation-alias/
	:alt: Requirements Status

.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/deprecation-alias/master?logo=coveralls
	:target: https://coveralls.io/github/domdfcoding/deprecation-alias?branch=master
	:alt: Coverage

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/deprecation-alias?logo=codefactor
	:target: https://www.codefactor.io/repository/github/domdfcoding/deprecation-alias
	:alt: CodeFactor Grade

.. |pypi-version| image:: https://img.shields.io/pypi/v/deprecation-alias
	:target: https://pypi.org/project/deprecation-alias/
	:alt: PyPI - Package Version

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/deprecation-alias?logo=python&logoColor=white
	:target: https://pypi.org/project/deprecation-alias/
	:alt: PyPI - Supported Python Versions

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/deprecation-alias
	:target: https://pypi.org/project/deprecation-alias/
	:alt: PyPI - Supported Implementations

.. |wheel| image:: https://img.shields.io/pypi/wheel/deprecation-alias
	:target: https://pypi.org/project/deprecation-alias/
	:alt: PyPI - Wheel

.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/deprecation-alias?logo=anaconda
	:target: https://anaconda.org/domdfcoding/deprecation-alias
	:alt: Conda - Package Version

.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/deprecation-alias?label=conda%7Cplatform
	:target: https://anaconda.org/domdfcoding/deprecation-alias
	:alt: Conda - Platform

.. |license| image:: https://img.shields.io/github/license/domdfcoding/deprecation-alias
	:target: https://github.com/domdfcoding/deprecation-alias/blob/master/LICENSE
	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/deprecation-alias
	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/deprecation-alias/v0.3.2
	:target: https://github.com/domdfcoding/deprecation-alias/pulse
	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/deprecation-alias
	:target: https://github.com/domdfcoding/deprecation-alias/commit/master
	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2023
	:alt: Maintenance

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/deprecation-alias
	:target: https://pypi.org/project/deprecation-alias/
	:alt: PyPI - Downloads

.. end shields

Installation
--------------

.. start installation

``deprecation-alias`` can be installed from PyPI or Anaconda.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install deprecation-alias

To install with ``conda``:

	* First add the required channels

	.. code-block:: bash

		$ conda config --add channels https://conda.anaconda.org/conda-forge
		$ conda config --add channels https://conda.anaconda.org/domdfcoding

	* Then install

	.. code-block:: bash

		$ conda install deprecation-alias

.. end installation
