codecrumbs 0.1.0

leave codecrumbs behind so that other can adopt the changes

codecrumbs

Codecrumbs is a Python library (and pytest plugin) for source code refactoring across library boundaries. It allows you to change the API of your library and to propagate this changes to every one who uses your library.

More can be found in the documentation.

Example

Simple example which renames one argument:

class Example:
    # old code ...
    # def method(self,v):
    #    print(v)

    @renamed_argument("v", "value")
    def method(self, value):
        print(value)


# some where else
e = Example()

e.method(v=5)

and apply the refactoring later

# if you have a standalone script
codecrumbs example.py
# or if you have tests
pytest --codecrumbs-fix test_example.py

which will rename the argument

e.method(value=5)

You can use codecrumbs instead of python to execute your code, or pytest to run your tests and apply the renamings automatically.

This can be used to fix the small things in your library you wanted to fix but never did, because you wanted to stay backwards compatible or didn't wanted you user to fix 1000 renamings in their code.

Installation

You can install codecrumbs via pip from PyPI:

pip install codecrumbs

The pytest support comes out of the box and everyone who depends on your library can use pytest --codecrumbs-fix to apply the changes you declared.

Features

With codecrumbs you can fix:

• method / attribute names
• rename named arguments of functions

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

Issues

If you encounter any problems, please file an issue along with a detailed description.

License

Distributed under the terms of the MIT license, "pytest-codecrumbs" is free and open source software