Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Flake8 plugin warning for unsafe functions

Project description

Alfred the butler
=================

[![Build Status](https://travis-ci.org/datatheorem/flake8-alfred.svg?branch=master)](https://travis-ci.org/datatheorem/flake8-alfred)
[![PyPI version](https://badge.fury.io/py/flake8-alfred.svg)](https://badge.fury.io/py/flake8-alfred)

Alfred is a flake8 plugin to warn on unsafe/obsolete symbols. You can use it as
a transition tool to eliminate functions, modules, variables you don't want in
existing project or you want to avoid in new ones. This plugin requires Python 3.6.

Getting Started
---------------

First, install Alfred using pip:

```bash
$ pip install flake8-alfred
```

Then, enable the plugin by configuring a blacklist of Python symbols that should
be flagged by flake8. Here is an example of configuration in your project's `setup.cfg`:

```ini
[flake8]
enable-extensions = B1
warn-symbols =
obsolete_module = Warning! This module is obsolete!
module.obsolete_function = Warning! This function is obsolete!
module.submodule.constant = Warning! this variable will be removed!
```

Here `enable-extensions` tells flake8 to enable this plugin and `warn-symbols` is
the list of symbols we want to flag in our project, with the associated
warning. By default, this plugin doesn't warn about any other symbol.


If you just want to test/run once, you can also pass the configuration directly
to flake8:

```bash
$ flake8 --enable-extensions=B1 --warn-symbols=$'obsolte_module=Warning!\nmodule.obsolete_function=Warning!'
```

Local Development
-----------------

First, clone the repository:

```bash
git clone https://github.com/datatheorem/alfred-checker.git
```

The project uses pipenv to manage dependencies:

```bash
$ pipenv install --dev
```

Then, the test suite can be run:

```bash
$ pipenv run pytest
```


Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
flake8_alfred-1.1.1-py3-none-any.whl (11.7 kB) Copy SHA256 hash SHA256 Wheel py3 Aug 16, 2018
flake8-alfred-1.1.1.tar.gz (6.2 kB) Copy SHA256 hash SHA256 Source None Aug 16, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page