Development Status
- 5 - Production/Stable
- 6 - Mature
Intended Audience
- Developers
License
- OSI Approved :: Apache Software License
Operating System
- MacOS :: MacOS X
- Microsoft :: Windows
- POSIX
Programming Language
- Python
- Python :: 3
Topic
- Software Development :: Libraries
- Software Development :: Libraries :: Python Modules
- Utilities
This library provides two very simple decorators that document the public visibility of the names in your module. They keep your module’s __all__ in sync so you don’t have to.
Also included is a function that you can put at the bottom of your module to simply infer all the public names, and populate the __all__ for you.
Installation
$ pip install atpublic
The install extra additionally installs @public and @private into builtins, so they’re always available without having to import them first:
$ pip install atpublic[install]
Note that while the top-level module is named public, the PyPI package is called atpublic due to a name conflict. Do not install public; that is a different package!
Project details
Project home: https://gitlab.com/flufl/public
Report bugs at: https://gitlab.com/flufl/public/-/work_items
Code hosting: https://gitlab.com/flufl/public.git
Documentation: https://public.readthedocs.io