Skip to main content

A lint framework that writes better Python code for you.

Project description

Fixit

Documentation codecov-badge PYPI PYPI Download

A lint framework that writes better Python code for you.

Fixit is a lint framework that complements Flake8. It’s based on LibCST which makes it possible to provide auto-fixes. Lint rules are made easy to build through pattern matching, a test toolkit, and utility helpers (e.g. scope analysis) for non-trivial boilerplate. It is optimized for efficiency, easy to customize and comes with many builtin lint rules.

Getting Started

To install Fixit:

pip install fixit

Fixit provides CLI commands. To run built-in Fixit rules on existing code to get code quality suggestions:

python -m fixit.cli.run_rules

To apply autofix on existing code:

python -m fixit.cli.apply_fix

You can learn more about how to configure Fixit, build a lint rule, test a lint rule from our tutorials. Try it out with our notebook examples.

Further Reading

Development

Start by setting up and activating a virtualenv:

git clone git@github.com:Instagram/Fixit.git fixit
cd fixit
python3 -m venv ../fixit-env/  # just an example, put this wherever you want
source ../fixit-env/bin/activate
pip install --upgrade pip  # optional, if you have an old system version of pip
pip install -r requirements.txt -r requirements-dev.txt
# If you're done with the virtualenv, you can leave it by running:
deactivate

We use isort and black to format code. To format changes to be conformant, run the following in the root:

tox -e autofix

To run all tests, you’ll need to install tox and do the following in the root: (use py37, py38 to choose from Python version 3.7 or 3.8):

tox -e py38

You can also run individual unit tests by specifying a module like this:

tox -e py38 -- fixit.common.tests.test_report

To run all test cases of a specific rule (e.g. NoInheritFromObjectRule):

tox -e py38 -- fixit.tests.NoInheritFromObjectRule

See the unittest documentation for more examples of how to run tests.

We use Pyre for type-checking. To verify types for the library, do the following in the root:

pyre --preserve-pythonpath check

To generate documentation, do the following in the root:

tox -e docs

License

Fixit is MIT licensed, as found in the LICENSE file.

Privacy Policy and Terms of Use

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fixit1-0.1.4.tar.gz (97.8 kB view details)

Uploaded Source

Built Distribution

fixit1-0.1.4-py3-none-any.whl (144.2 kB view details)

Uploaded Python 3

File details

Details for the file fixit1-0.1.4.tar.gz.

File metadata

  • Download URL: fixit1-0.1.4.tar.gz
  • Upload date:
  • Size: 97.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for fixit1-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f91b44659586181ccce11e85f206b38b2bdef17a363fe8e89fdfb44aa2dbcbe3
MD5 7cd251cd284021fae6e00f03e8dd10d5
BLAKE2b-256 5aa7a2170058be7534baad1925c0e31724754a2d94ab3b853120dc6ce2a04a35

See more details on using hashes here.

Provenance

File details

Details for the file fixit1-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: fixit1-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 144.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for fixit1-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bc294cb2763cd0ae1633228504a0082471d78129e84268bae13431754b032466
MD5 d7f019a48e063b3212e91784d1d426a5
BLAKE2b-256 2e2b5e5c5d024bfa3e092ec396acfbf418ae63d304f9b987c389e2fa109fa8f1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page