Skip to content

Atom package for python linting with project specific configurations

License

Notifications You must be signed in to change notification settings

csbasil/atom-py-linters

 
 

Repository files navigation

Customizable Python Lintor for Atom

repo status Active last commit

py-linters_BugTracker Build Status

This atom package is a modified version of atom python-linters package. It is an all-in-one linter for python code which internally use multiple linting tools:

The lint triggers of all of those linting tools can individually be configure to

  • Lint as you type
  • Lint on file save
  • Never

If any of the above lint tool is not installed, it will be detected and a user friendly message will guide you to either install it or change its lint trigger to 'Never'.

To provide specific lint options, py-linters supports setup.cfg configuration file format which is supported by all of the above lint tool.

Having lint options in a file external to the IDE settings allows to share the configuration with other process like manual run or CI and therefore obtain consistent lint results.

To provide project specific package configurations, py-linters support an external toml file. When toml file is provided, all the global settings for py-linters package is ignored and settings from toml file is used. This feature allows to override the global py-linters settings and keeps project specific py-linters configurations.

Toml File Options

Following variables can be set from toml for project specific configurations:

PythonPath="%PROJECT_PATH/env/bin"
PythonExecutable="%PROJECT_PATH/env/bin/python3"
LintConfig=""

All empty varibles in the toml must be provided with empty strings like LintConfig

Prerequisites

  • atom must be installed which will provide the apm command aka Atom Package Manager.

Installation Steps

apm install py-linters

⎇ Alternatives

Use the following atom linting packages:

⚖️ License

This project is licensed under the MIT License - see the LICENSE.txt file for details

👩👨

About

Atom package for python linting with project specific configurations

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 96.1%
  • Makefile 3.9%