Metadata-Version: 2.1
Name: classprop
Version: 0.1.1
Summary: No description has been added so far.
Home-page: https://github.com/romnn/classprop
Author: romnn
Author-email: contact@romnn.com
License: MIT
Keywords: classprop
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Requires-Dist: Click (>=6.0)
Provides-Extra: dev
Requires-Dist: Click (>=6.0) ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-xdist ; extra == 'dev'
Requires-Dist: pytest-sugar ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pyfakefs ; extra == 'dev'
Requires-Dist: coverage ; extra == 'dev'
Requires-Dist: codecov ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: black (==19.10b0) ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: m2r ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: invoke ; extra == 'dev'
Requires-Dist: ruamel.yaml ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: cookiecutter ; extra == 'dev'
Requires-Dist: bump2version ; extra == 'dev'
Provides-Extra: docs
Provides-Extra: test
Requires-Dist: tox ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-xdist ; extra == 'test'
Requires-Dist: pytest-sugar ; extra == 'test'
Requires-Dist: mypy ; extra == 'test'
Requires-Dist: pyfakefs ; extra == 'test'

===============================
@classprop
===============================

.. image:: https://github.com/romnn/classprop/workflows/test/badge.svg
        :target: https://github.com/romnn/classprop/actions
        :alt: Build Status

.. image:: https://img.shields.io/pypi/v/classprop.svg
        :target: https://pypi.python.org/pypi/classprop
        :alt: PyPI version

.. image:: https://img.shields.io/github/license/romnn/classprop
        :target: https://github.com/romnn/classprop
        :alt: License

.. image:: https://codecov.io/gh/romnn/classprop/branch/master/graph/badge.svg
        :target: https://codecov.io/gh/romnn/classprop
        :alt: Test Coverage

""""""""

.. role:: python(code)
   :language: python

Small python package that provides a :python:`@classproperty` decorator for python classes
that works just like :python:`@property` except for class variables!

.. code-block:: console

    $ pip install classprop

Use it just like builtin :python:`@property`'s:

.. code-block:: python

    from classprop import classprop

    class TestClass:
        _internal = "Hello, World"

        @classprop
        def my_class_prop(self) -> str:
            return self._internal

        @my_class_prop.setter
        def my_class_prop(self, value: str) -> None:
            self._internal = value



    foo = TestClass()
    assert foo.my_class_prop == "Hello, World"

    baz = TestClass()
    assert baz.my_class_prop == "Hello, World"

    baz.my_class_prop = "Changed"
    assert foo.my_class_prop == "Changed"


Development
-----------

For detailed instructions see `CONTRIBUTING <CONTRIBUTING.rst>`_.

Tests
~~~~~~~
You can run tests with

.. code-block:: console

    $ invoke test
    $ invoke test --min-coverage=90     # Fail when code coverage is below 90%
    $ invoke type-check                 # Run mypy type checks

Linting and formatting
~~~~~~~~~~~~~~~~~~~~~~~~
Lint and format the code with

.. code-block:: console

    $ invoke format
    $ invoke lint

All of this happens when you run ``invoke pre-commit``.

Note
-----

This project is still in the alpha stage and should not be considered production ready.


