openstack/tacker
Code Issues Proposed changes
Files
96d4ac6353b674ff8b7d9a8e7246b18b8222c8a1
tacker/doc/source/contributor/development.environment.rst
Masaki UENO 4f25101c17 Update Pylint config file for development 
Current Tacker repository contains .pylintrc, which is a configuration
file of Pylint [1].

[1] https://pylint.org/

However, it is not maintained for 8 years ago,
so it contains some out-of-date configurations
for current Pylint version.

This patch removes those out-of-date configurations,
and introduces some useful configurations for IDE integration.

Signed-off-by: Masaki UENO <masaki.ueno.up@hco.ntt.co.jp>
Change-Id: I9e09a6befef2ef22e09f1a0b0ed2a75bf173a4f6
2021-12-10 02:38:07 +00:00

2.6 KiB
Raw Blame History

Setting Up a Development Environment

This page describes how to setup a working Python development environment that can be used in developing Tacker on Ubuntu, Fedora or Mac OS X. These instructions assume you're already familiar with Git and Gerrit, which is a code repository mirror and code review toolset , however if you aren't please see this Git tutorial for an introduction to using Git and this guide for a tutorial on using Gerrit and Git for code contribution to OpenStack projects.

If you want to be able to run Tacker in a full OpenStack environment, you can use the excellent DevStack project to do so. There is a wiki page that describes setting up Tacker using DevStack.

Getting the code

Grab the code:

git clone https://opendev.org/openstack/tacker.git
cd tacker

Linting

Tacker project supports the configuration of Pylint, a lint tool for Python code.

You can get Pylint CLI tool from PyPI:

$ pip install pylint

Then you can check your code with Pylint like:

$ pylint path/to/code

If you want to check the entire Tacker code:

$ pylint tacker/

.pylintrc in Tacker repository root is a configuration file of Pylint.

If you want to check Pylint messages, detailed CLI configurations and configurations in .pylintrc, please refer to Pylint official reference.