Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add __all__ with public names #33

Merged
merged 2 commits into from
Apr 18, 2021
Merged

Add __all__ with public names #33

merged 2 commits into from
Apr 18, 2021

Commits on Apr 18, 2021

  1. Add __all__ to __init__.py 

    https://docs.python.org/3/reference/simple_stmts.html#the-import-statement

In Python, `__all__` is a sequence (typically a list or tuple) that
defines the public names of a module or package. When other applications
install the package, the objects corresponding to the public names are
exposed for direct import and use.

This commit will add `__all__`, defining the public API of the package.
To start, the public API will consist of a few useful utilities that are
commonly imported in other Python applications, such as the logging
configuration logic and HTTP Basic auth implementations.
    @br3ndonland
    br3ndonland committed Apr 18, 2021
    Configuration menu
    Copy the full SHA
    827c1c7 View commit details
    Browse the repository at this point in the history

  2. Update LOGGING_CONFIG import in README example 

    Now that inboard has `__all__`, which includes the `LOGGING_CONFIG`, the
`LOGGING_CONFIG` can be imported from the top-level package.
    @br3ndonland
    br3ndonland committed Apr 18, 2021
    Configuration menu
    Copy the full SHA
    b9b0f2f View commit details
    Browse the repository at this point in the history