Metadata-Version: 2.4
Name: griffe-public-redundant-aliases
Version: 0.3.0
Summary: Mark objects imported with redundant aliases as public.
Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
License-Expression: ISC
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Project-URL: Homepage, https://mkdocstrings.github.io/griffe-public-redundant-aliases
Project-URL: Documentation, https://mkdocstrings.github.io/griffe-public-redundant-aliases
Project-URL: Changelog, https://mkdocstrings.github.io/griffe-public-redundant-aliases/changelog
Project-URL: Repository, https://github.com/mkdocstrings/griffe-public-redundant-aliases
Project-URL: Issues, https://github.com/mkdocstrings/griffe-public-redundant-aliases/issues
Project-URL: Discussions, https://github.com/mkdocstrings/griffe-public-redundant-aliases/discussions
Project-URL: Gitter, https://gitter.im/mkdocstrings/griffe-public-redundant-aliases
Project-URL: Funding, https://github.com/sponsors/pawamoy
Requires-Python: >=3.10
Requires-Dist: griffe>=1.14
Description-Content-Type: text/markdown

# griffe-public-redundant-aliases

[![ci](https://github.com/mkdocstrings/griffe-public-redundant-aliases/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-public-redundant-aliases/actions?query=workflow%3Aci)
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe-public-redundant-aliases/)
[![pypi version](https://img.shields.io/pypi/v/griffe-public-redundant-aliases.svg)](https://pypi.org/project/griffe-public-redundant-aliases/)
[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#griffe-public-redundant-aliases:gitter.im)

Mark objects imported with redundant aliases as public.

## Installation

```bash
pip install griffe-public-redundant-aliases
```

## Usage

[Enable](https://mkdocstrings.github.io/griffe/guide/users/extending/#using-extensions) the `griffe_public_redundant_aliases` extension. Now all objects imported with redundant aliases will be marked as public, as per the convention.

```python
# Following objects will be marked as public.
from somewhere import Thing as Thing
from somewhere import Other as Other

# Following object won't be marked as public.
from somewhere import Stuff
```

With MkDocs:

```yaml
plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_public_redundant_aliases
```

## Sponsors

<!-- sponsors-start -->
<!-- sponsors-end -->
