Metadata-Version: 2.1
Name: github_reserved_names
Version: 2023.5.2
Summary: A list of paths that GitHub uses which aren't real users
Project-URL: Homepage, https://github.com/Julian/github-reserved-names
Project-URL: Issues, https://github.com/Julian/github-reserved-names/issues/
Project-URL: Source, https://github.com/Julian/github-reserved-names
Author: Julian Berman
Author-email: Julian+github_reserved_names@GrayVines.com
License: MIT
License-File: COPYING
Keywords: github,github api
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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
Description-Content-Type: text/x-rst

=========================
``github-reserved-names``
=========================

|PyPI| |Pythons| |CI|

.. |PyPI| image:: https://img.shields.io/pypi/v/github-reserved-names.svg
  :alt: PyPI version
  :target: https://pypi.org/project/github-reserved-names/

.. |Pythons| image:: https://img.shields.io/pypi/pyversions/github-reserved-names.svg
  :alt: Supported Python versions
  :target: https://pypi.org/project/github-reserved-names/

.. |CI| image:: https://github.com/Julian/github-reserved-names/workflows/CI/badge.svg
  :alt: Build status
  :target: https://github.com/Julian/github-reserved-names/actions?query=workflow%3ACI

Usage
-----

A single ``set`` is exposed, containing the reserved names:

.. code:: python

    >>> import github_reserved_names
    >>> "sponsors" in github_reserved_names.ALL
    True


Source
------

The source of this data is the `npm github-reserved-names project <https://npm.im/github-reserved-names>`_

This module attempts to provide a mirror of that project as a Python module.

If you feel a path is missing, please file a pull request upstream and it will be pulled in here.
