https://github.com/mkdocstrings/griffe-public-redundant-aliases

Mark objects imported with redundant aliases as public. Available to sponsors only.
https://github.com/mkdocstrings/griffe-public-redundant-aliases

griffe griffe-extension public-api redundant-aliases

Last synced: 3 months ago
JSON representation

Mark objects imported with redundant aliases as public. Available to sponsors only.

• Host: GitHub
• URL: https://github.com/mkdocstrings/griffe-public-redundant-aliases
• Owner: mkdocstrings
• License: isc
• Created: 2024-08-17T16:14:33.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-11-08T17:48:36.000Z (7 months ago)
• Last Synced: 2025-11-08T18:04:39.211Z (7 months ago)
• Topics: griffe, griffe-extension, public-api, redundant-aliases
• Language: Python
• Homepage: https://mkdocstrings.github.io/griffe-public-redundant-aliases
• Size: 575 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# 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-zensical-FF9100.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





Silver sponsors











Bronze sponsors











---





































































*And 7 more private sponsor(s).*