Pylama Documentation. Release Kirill Klenov

Size: px
Start display at page:

Download "Pylama Documentation. Release Kirill Klenov"

Transcription

1 Pylama Documentation Release Kirill Klenov Sep 13, 2017

2

3 Contents I Requirements: 3 II Installation: 7 III Quickstart 11 IV Set Pylama (checkers) options 15 1 Command line options 17 2 File modelines 19 3 Skip lines (noqa) 21 4 Configuration file 23 5 Set Code-checkers options 25 6 Set options for file (group of files) 27 V Pytest integration 29 VI Writing a linter 33 7 Example: 37 8 Run pylama from python code 39 9 Bug tracker Contributing Contributors License 45 i

4 ii

5 Pylama Documentation, Release Welcome to Pylama s documentation. Code audit tool for Python and JavaScript. Pylama wraps these tools: pycodestyle (formerly pep8) , Florent Xicluna; pydocstyle (formerly pep257 by Vladimir Keleshev) 2014, Amir Rachum; PyFlakes , Kevin Watters; Mccabe Ned Batchelder; Pylint 2013, Logilab (should be installed pylama_pylint module); Radon Michele Lacchia gjslint The Closure Linter Authors (should be installed pylama_gjslint module); copyright 2013 by Kirill Klenov. license BSD, see LICENSE for more details. Contents Welcome to Pylama Requirements: Installation: Quickstart Set Pylama (checkers) options Command line options File modelines Skip lines (noqa) Configuration file Set Code-checkers options Set options for file (group of files) Pytest integration Writing a linter Example: Run pylama from python code Bug tracker Contributing * Contributors Contents 1

6 Pylama Documentation, Release License 2 Contents

7 Part I Requirements: 3

8

9 Pylama Documentation, Release Python (2.7, 3.2, 3.3) To use JavaScript checker (gjslint) you need to install python-gflags with pip install python-gflags. If your tests are failing on Win platform you are missing: curses - (The curses library supplies a terminal-independent screen-painting and keyboard-handling facility for textbased terminals) 5

10 Pylama Documentation, Release

11 Part II Installation: 7

12

13 Pylama Documentation, Release Pylama could be installed using pip: :: $ pip install pylama 9

14 Pylama Documentation, Release

15 Part III Quickstart 11

16

17 Pylama Documentation, Release Pylama is easy to use and really fun for checking code quality. Just run pylama and get common output from all pylama plugins (pycodestyle, PyFlakes and etc) Recursive check the current directory. $ pylama Recursive check a path. $ pylama <path_to_directory_or_file> Ignore errors $ pylama -i W,E501 Note: You could choose a group erros D, E1 and etc or special errors C0312 Choose code checkers $ pylama -l "pycodestyle,mccabe" Choose code checkers for JavaScript: $ pylama --linters=gjslint --ignore=e:0010 <path_to_directory_or_file> 13

18 Pylama Documentation, Release

19 Part IV Set Pylama (checkers) options 15

20

21 CHAPTER 1 Command line options $ pylama --help usage: pylama [-h] [--verbose] [--version] [--format {pycodestyle,pylint}] [--select SELECT] [--sort SORT] [--linters LINTERS] [--ignore IGNORE] [--skip SKIP] [--report REPORT] [--hook] [--async] [--options OPTIONS] [--force] [--abspath] [paths [paths...]] Code audit tool for python. positional arguments: paths Paths to files or directories for code check. optional arguments: -h, --help show this help message and exit --verbose, -v Verbose mode. --version show program's version number and exit --format {pycodestyle,pylint}, -f {pycodestyle,pylint} Choose errors format (pycodestyle, pylint). --select SELECT, -s SELECT Select errors and warnings. (comma-separated list) --sort SORT Sort result by error types. Ex. E,W,D --linters LINTERS, -l LINTERS Select linters. (comma-separated). Choices are mccabe,pycodestyle,pyflakes,pydocstyle. --ignore IGNORE, -i IGNORE Ignore errors and warnings. (comma-separated) --skip SKIP Skip files by masks (comma-separated, Ex. */messages.py) --report REPORT, -r REPORT Send report to file [REPORT] --hook Install Git (Mercurial) hook. --async Enable async mode. Useful for checking a lot of files. Not supported by pylint. --options FILE, -o FILE 17

22 Pylama Documentation, Release force, -F --abspath, -a Specify configuration file. Looks for pylama.ini, setup.cfg, tox.ini, or pytest.ini in the current directory. Force code checking (if linter doesnt allow) Use absolute paths in output. 18 Chapter 1. Command line options

23 CHAPTER 2 File modelines You can set options for Pylama inside a source file. Use pylama modeline for this. Format: # pylama:{name1}={value1}:{name2}={value2}:..... Somethere in code # pylama:ignore=w:select=w301 Disable code checking for current file:.. Somethere in code # pylama:skip=1 Those options have a higher priority. 19

24 Pylama Documentation, Release Chapter 2. File modelines

25 CHAPTER 3 Skip lines (noqa) Just add # noqa in end of line to ignore. def urgent_fuction(): unused_var = 'No errors here' # noqa 21

26 Pylama Documentation, Release Chapter 3. Skip lines (noqa)

27 CHAPTER 4 Configuration file Pylama looks for a configuration file in the current directory. The program searches for the first matching ini-style configuration file in the directories of command line argument. Pylama looks for the configuration in this order: pylama.ini setup.cfg tox.ini pytest.ini The option / -o argument can be used to specify a configuration file. Pylama searches for sections whose names start with pylama. The pylama section configures global options like linters and skip. [pylama] format = pylint skip = */.tox/*,*/.env/* linters = pylint,mccabe ignore = F0401,C0111,E731 23

28 Pylama Documentation, Release Chapter 4. Configuration file

29 CHAPTER 5 Set Code-checkers options You could set options for special code checker with pylama configurations. [pylama:pyflakes] builtins = _ [pylama:pycodestyle] max_line_length = 100 [pylama:pylint] max_line_length = 100 disable = R See code-checkers documentation for more info. 25

30 Pylama Documentation, Release Chapter 5. Set Code-checkers options

31 CHAPTER 6 Set options for file (group of files) You could set options for special file (group of files) with sections: The options have a higher priority than in the pylama section. [pylama:*/pylama/main.py] ignore = C901,R0914,W0212 select = R [pylama:*/tests.py] ignore = C0110 [pylama:*/setup.py] skip = 1 27

32 Pylama Documentation, Release Chapter 6. Set options for file (group of files)

33 Part V Pytest integration 29

34

35 Pylama Documentation, Release Pylama has Pytest support. The package automatically registers itself as a pytest plugin during installation. Pylama also supports pytest_cache plugin. Check files with pylama pytest --pylama... Recommended way to set pylama options when using pytest configuration files (see below). 31

36 Pylama Documentation, Release

37 Part VI Writing a linter 33

38

39 Pylama Documentation, Release You can write a custom extension for Pylama. Custom linter should be a python module. Name should be like pylama_<name>. In setup.py, pylama.linter entry point should be defined. setup( #... entry_points={ 'pylama.linter': ['lintername = pylama_lintername.main:linter'], } #... ) Linter should be instance of pylama.lint.linter class. Must implement two methods: allow takes a path and returns true if linter can check this file for errors. run takes a path and meta keywords params and returns a list of errors. 35

40 Pylama Documentation, Release

41 CHAPTER 7 Example: Just a virtual WOW checker. setup.py: setup( name='pylama_wow', install_requires=[ 'setuptools' ], entry_points={ 'pylama.linter': ['wow = pylama_wow.main:linter'], } #... ) pylama_wow.py: from pylama.lint import Linter as BaseLinter class Linter(BaseLinter): def allow(self, path): return 'wow' in path def run(self, path, **meta): with open(path) as f: if 'wow' in f.read(): return [{ lnum: 0, col: 0, text: 'Wow has been finded.', type: 'WOW' }] 37

42 Pylama Documentation, Release Chapter 7. Example:

43 CHAPTER 8 Run pylama from python code from pylama.main import check_path, parse_options my_redefined_options = {...} my_path = '...' options = parse_options([my_path], **my_redefined_options) errors = check_path(options) 39

44 Pylama Documentation, Release Chapter 8. Run pylama from python code

45 CHAPTER 9 Bug tracker If you have any suggestions, bug reports or annoyances please report them to the issue tracker at klen/pylama/issues 41

46 Pylama Documentation, Release Chapter 9. Bug tracker

47 CHAPTER 10 Contributing Development of pylama happens at GitHub: Contributors See AUTHORS. 43

48 Pylama Documentation, Release Chapter 10. Contributing

49 CHAPTER 11 License Licensed under a BSD license. 45

flake8 Documentation Release Tarek Ziade

flake8 Documentation Release Tarek Ziade flake8 Documentation Release 2.5.5 Tarek Ziade June 14, 2016 Contents 1 QuickStart 3 2 Frequently Asked Questions 5 2.1 Why does flake8 pin the version of pep8?................................ 5 2.2 Is

More information

Django-CSP Documentation

Django-CSP Documentation Django-CSP Documentation Release 3.0 James Socol, Mozilla September 06, 2016 Contents 1 Installing django-csp 3 2 Configuring django-csp 5 2.1 Policy Settings..............................................

More information

pydocstyle Documentation

pydocstyle Documentation pydocstyle Documentation Release 1.0.0 Amir Rachum Oct 14, 2018 Contents 1 Quick Start 3 1.1 Usage................................................... 3 1.2 Error Codes................................................

More information

Archan. Release 2.0.1

Archan. Release 2.0.1 Archan Release 2.0.1 Jul 30, 2018 Contents 1 Archan 1 1.1 Features.................................................. 1 1.2 Installation................................................ 1 1.3 Documentation..............................................

More information

pytest-benchmark Release 2.5.0

pytest-benchmark Release 2.5.0 pytest-benchmark Release 2.5.0 September 13, 2015 Contents 1 Overview 3 1.1 pytest-benchmark............................................ 3 2 Installation 7 3 Usage 9 4 Reference 11 4.1 pytest_benchmark............................................

More information

PyBuilder Documentation

PyBuilder Documentation PyBuilder Documentation Release 0.10 PyBuilder Team Jun 21, 2018 Contents 1 Installation 1 1.1 Virtual Environment........................................... 1 1.2 Installing completions..........................................

More information

tinycss Documentation

tinycss Documentation tinycss Documentation Release 0.4 Simon Sapin Mar 25, 2017 Contents 1 Requirements 3 2 Installation 5 3 Documentation 7 3.1 Parsing with tinycss........................................... 7 3.2 CSS 3

More information

Release Ralph Offinger

Release Ralph Offinger nagios c heck p aloaltodocumentation Release 0.3.2 Ralph Offinger May 30, 2017 Contents 1 nagios_check_paloalto: a Nagios/Icinga Plugin 3 1.1 Documentation..............................................

More information

CUSTOM CODE CHECKS. Anton Marchukov. PyCon Israel 2017

CUSTOM CODE CHECKS. Anton Marchukov. PyCon Israel 2017 Anton Marchukov PyCon Israel 2017 ABOUT ME @martchukov Senior Software Engineer at Red Hat. ovirt Community Infra team. CI and related infrastructure. Lots of automation in Python. DevOps advocate. ovirt

More information

IoT Relay Documentation

IoT Relay Documentation IoT Relay Documentation Release 1.2.2 Emmanuel Levijarvi January 16, 2017 Contents 1 Installation 3 2 Source 5 3 License 7 4 Contents 9 4.1 Running IoT Relay............................................

More information

Mixer Documentation. Release Kirill Klenov

Mixer Documentation. Release Kirill Klenov Mixer Documentation Release 6.0.1 Kirill Klenov Sep 28, 2018 Contents 1 User s Guide 3 1.1 Installation................................................ 3 1.2 Quickstart................................................

More information

pycodestyle documentation

pycodestyle documentation pycodestyle documentation Release 2.3.1 Johann C. Rocholl, Florent Xicluna, Ian Lee Nov 18, 2017 Contents 1 Introduction 3 1.1 Features.................................................. 3 1.2 Disclaimer................................................

More information

Python Development Workflow

Python Development Workflow Python Development Workflow Best Practice to create / test / versioning / automate and more Marcelo Mello mmello@redhat.com / tchello.mello@gmail.com Pablo Hess phess@redhat.com / pablonhess@gmail.com

More information

Mantis STIX Importer Documentation

Mantis STIX Importer Documentation Mantis STIX Importer Documentation Release 0.2.0 Siemens February 27, 2014 Contents 1 Mantis STIX Importer 3 1.1 Documentation.............................................. 3 1.2 Quickstart................................................

More information

Python Packaging. Jakub Wasielak

Python Packaging. Jakub Wasielak Python Packaging Jakub Wasielak http://blog.pykonik.org/ http://koderek.edu.pl/ facebook.com/startechkrk https://pl.pycon.org/2017/ What? Why? Architecture https://packaging.python.org/current/ Installation

More information

Continuous Integration INRIA

Continuous Integration INRIA Vincent Rouvreau - https://sed.saclay.inria.fr February 28, 2017 Contents 1 Preamble In this exercice, you will learn how to install your Python program with packaging tools, test it, measure the tests

More information

DNS Zone Test Documentation

DNS Zone Test Documentation DNS Zone Test Documentation Release 1.1.3 Maarten Diemel Dec 02, 2017 Contents 1 DNS Zone Test 3 1.1 Features.................................................. 3 1.2 Credits..................................................

More information

PrettyPandas Documentation

PrettyPandas Documentation PrettyPandas Documentation Release 0.0.4 Henry Hammond Mar 26, 2018 Contents 1 Features 3 2 Installation 5 3 Contributing 7 4 Contents 9 4.1 Quick Start................................................

More information

doconv Documentation Release Jacob Mourelos

doconv Documentation Release Jacob Mourelos doconv Documentation Release 0.1.6 Jacob Mourelos October 17, 2016 Contents 1 Introduction 3 2 Features 5 2.1 Available Format Conversions...................................... 5 3 Installation 7 3.1

More information

Black Mamba Documentation

Black Mamba Documentation Black Mamba Documentation Release 1.4.3 Robert Vojta Jan 11, 2018 Contents 1 About Black Mamba 3 2 Black Mamba User Guide 5 3 Black Mamba Reference 15 4 Contribution 25 5 Development 27 6 FAQ 29 7 Gallery

More information

TPS Documentation. Release Thomas Roten

TPS Documentation. Release Thomas Roten TPS Documentation Release 0.1.0 Thomas Roten Sep 27, 2017 Contents 1 TPS: TargetProcess in Python! 3 2 Installation 5 3 Contributing 7 3.1 Types of Contributions..........................................

More information

Flask-Sitemap Documentation

Flask-Sitemap Documentation Flask-Sitemap Documentation Release 0.3.0 CERN May 06, 2018 Contents 1 Contents 3 2 Installation 5 2.1 Requirements............................................... 5 3 Usage 7 3.1 Simple Example.............................................

More information

Frontier Documentation

Frontier Documentation Frontier Documentation Release 0.1.3-dev Sam Nicholls August 14, 2014 Contents 1 Frontier 3 1.1 Requirements............................................... 3 1.2 Installation................................................

More information

django CMS Export Objects Documentation

django CMS Export Objects Documentation django CMS Export Objects Documentation Release 0.1.0 Iacopo Spalletti Sep 07, 2017 Contents 1 django CMS Export Objects 3 1.1 Features.................................................. 3 1.2 Documentation..............................................

More information

Automating the Creation and Deployment of New Robot Framework Libraries

Automating the Creation and Deployment of New Robot Framework Libraries Meri Alho Automating the Creation and Deployment of New Robot Framework Libraries Metropolia University of Applied Sciences Bachelor of Engineering Information and Communications Technology Thesis 20 April

More information

wheel Documentation Release Daniel Holth

wheel Documentation Release Daniel Holth wheel Documentation Release 0.32.2 Daniel Holth Oct 20, 2018 Contents 1 Quickstart 3 2 Installation 5 2.1 Python and OS Compatibility...................................... 5 3 User Guide 7 3.1 Building

More information

Watson - Events. Release 1.0.3

Watson - Events. Release 1.0.3 Watson - Events Release 1.0.3 Jan 15, 2018 Contents 1 Build Status 3 2 Installation 5 3 Testing 7 4 Contributing 9 5 Table of Contents 11 5.1 Usage................................................... 11

More information

Conda Documentation. Release latest

Conda Documentation. Release latest Conda Documentation Release latest August 09, 2015 Contents 1 Installation 3 2 Getting Started 5 3 Building Your Own Packages 7 4 Getting Help 9 5 Contributing 11 i ii Conda Documentation, Release latest

More information

websnort Documentation

websnort Documentation websnort Documentation Release 0.8 Steve Henderson Jul 04, 2018 Contents 1 Features 3 2 Contents 5 3 Issues 15 Python Module Index 17 i ii Websnort is an Open Source web service for analysing pcap files

More information

Python simple arp table reader Documentation

Python simple arp table reader Documentation Python simple arp table reader Documentation Release 0.0.1 David Francos Nov 17, 2017 Contents 1 Python simple arp table reader 3 1.1 Features.................................................. 3 1.2 Usage...................................................

More information

django-dynamic-db-router Documentation

django-dynamic-db-router Documentation django-dynamic-db-router Documentation Release 0.1.1 Erik Swanson August 24, 2016 Contents 1 Table of Contents 3 1.1 Installation................................................ 3 1.2 Quickstart................................................

More information

Django-frontend-notification Documentation

Django-frontend-notification Documentation Django-frontend-notification Documentation Release 0.2.0 Arezqui Belaid February 25, 2016 Contents 1 Introduction 3 1.1 Overview................................................. 3 1.2 Documentation..............................................

More information

Python Project Documentation

Python Project Documentation Python Project Documentation Release 1.0 Tim Diels Jan 10, 2018 Contents 1 Simple project structure 3 1.1 Code repository usage.......................................... 3 1.2 Versioning................................................

More information

Assignment 8: Data Structures in C++ and Python: wordplayer

Assignment 8: Data Structures in C++ and Python: wordplayer Assignment 8: Data Structures in C++ and Python: wordplayer EC602 Design by Software Fall 2018 Contents 1 Introduction 2 1.1 Assignment Goals........................... 2 1.2 Group Size..............................

More information

Python StatsD Documentation

Python StatsD Documentation Python StatsD Documentation Release 2.0.3 James Socol January 03, 2014 Contents i ii statsd is a friendly front-end to Graphite. This is a Python client for the statsd daemon. Quickly, to use: >>> import

More information

django-telegram-login Documentation

django-telegram-login Documentation django-telegram-login Documentation Release 0.2.3 Dmytro Striletskyi Aug 21, 2018 Contents 1 User s guide 3 1.1 Getting started.............................................. 3 1.2 How to use widgets............................................

More information

RedBarrel Documentation

RedBarrel Documentation RedBarrel Documentation Release 1.0 2011, Tarek Ziadé August 08, 2011 CONTENTS 1 What s RedBarrel? 3 1.1 Anatomy of a Web Service........................................ 3 1.2 The RBR DSL..............................................

More information

WRITING PYLINT PLUGINS

WRITING PYLINT PLUGINS WRITING PYLINT PLUGINS PyCon CZ 2018 Praha Alexander Todorov http://atodorov.org @atodorov_ OBJECTIVES To understand how a pylint plugin works To be able to write a non-complex plugin AST CRASH COURSE

More information

runtest Documentation

runtest Documentation runtest Documentation Release 2.1.1-rc-1 Radovan Bast Feb 07, 2018 About 1 Motivation 3 2 Audience 5 3 Similar projects 7 4 General tips 9 5 How to hook up runtest with your code 11 6 Example test script

More information

I2C LCD Documentation

I2C LCD Documentation I2C LCD Documentation Release 0.1.0 Peter Landoll Sep 04, 2017 Contents 1 I2C LCD 3 1.1 Features.................................................. 3 1.2 Credits..................................................

More information

g-pypi Documentation Release 0.3 Domen Kožar

g-pypi Documentation Release 0.3 Domen Kožar g-pypi Documentation Release 0.3 Domen Kožar January 20, 2014 Contents i ii Author Domen Kožar Source code Github.com source browser Bug tracker Github.com issues Generated January 20,

More information

Aldryn Installer Documentation

Aldryn Installer Documentation Aldryn Installer Documentation Release 0.2.0 Iacopo Spalletti February 06, 2014 Contents 1 django CMS Installer 3 1.1 Features.................................................. 3 1.2 Installation................................................

More information

twosheds Documentation

twosheds Documentation twosheds Documentation Release 0.1.0 Ceasar Bautista August 14, 2015 Contents 1 Features 3 2 User Guide 5 2.1 Installation................................................ 5 2.2 Quickstart................................................

More information

dh-virtualenv Documentation

dh-virtualenv Documentation dh-virtualenv Documentation Release 1.0 Spotify AB Sep 27, 2017 Contents 1 What is dh-virtualenv 3 2 Changelog 5 2.1 1.0.................................................... 5 2.2 0.11....................................................

More information

dothebackup Documentation

dothebackup Documentation dothebackup Documentation Release 2.1.1 Marvin Steadfast Jan 17, 2018 Contents 1 Guides 3 1.1 Installation................................................ 3 1.2 Usage...................................................

More information

Packtools Documentation

Packtools Documentation Packtools Documentation Release 2.1 SciELO Sep 28, 2017 Contents 1 User guide 3 1.1 Installing Packtools........................................... 3 1.2 Tutorial..................................................

More information

XStatic Documentation

XStatic Documentation XStatic Documentation Release 1.0.1 Thomas Waldmann Sep 18, 2018 Contents 1 What is XStatic 1 1.1 The Idea................................................. 1 1.2 Pros....................................................

More information

Pymixup Documentation

Pymixup Documentation Pymixup Documentation Release 1.0.2 Richard DeVost June 09, 2016 Contents 1 Why Obfuscate? 3 2 What pymixup Does 5 3 Contents 7 3.1 Installation................................................ 7 3.2 Program

More information

ejpiaj Documentation Release Marek Wywiał

ejpiaj Documentation Release Marek Wywiał ejpiaj Documentation Release 0.4.0 Marek Wywiał Mar 06, 2018 Contents 1 ejpiaj 3 1.1 License.................................................. 3 1.2 Features..................................................

More information

Pulp Python Support Documentation

Pulp Python Support Documentation Pulp Python Support Documentation Release 1.0.1 Pulp Project October 20, 2015 Contents 1 Release Notes 3 1.1 1.0 Release Notes............................................ 3 2 Administrator Documentation

More information

ndeftool documentation

ndeftool documentation ndeftool documentation Release 0.1.0 Stephen Tiedemann May 19, 2018 Contents 1 NDEFTOOL 3 1.1 Synopsis................................................. 3 1.2 Description................................................

More information

Python StatsD Documentation

Python StatsD Documentation Python StatsD Documentation Release 3.2.2 James Socol Dec 15, 2017 Contents 1 Installing 3 2 Contents 5 2.1 Configuring Statsd............................................ 5 2.2 Data Types................................................

More information

AnyDo API Python Documentation

AnyDo API Python Documentation AnyDo API Python Documentation Release 0.0.2 Aliaksandr Buhayeu Apr 25, 2017 Contents 1 anydo_api unofficial AnyDo API client for Python (v0.0.2 aplha) 3 1.1 Supported Features............................................

More information

BanzaiDB Documentation

BanzaiDB Documentation BanzaiDB Documentation Release 0.3.0 Mitchell Stanton-Cook Jul 19, 2017 Contents 1 BanzaiDB documentation contents 3 2 Indices and tables 11 i ii BanzaiDB is a tool for pairing Microbial Genomics Next

More information

Poetaster. Release 0.1.1

Poetaster. Release 0.1.1 Poetaster Release 0.1.1 September 21, 2016 Contents 1 Overview 1 1.1 Installation................................................ 1 1.2 Documentation.............................................. 1 1.3

More information

smartfilesorter Documentation

smartfilesorter Documentation smartfilesorter Documentation Release 0.2.0 Jason Short September 14, 2014 Contents 1 Smart File Sorter 3 1.1 Features.................................................. 3 2 Installation 5 3 Usage Example

More information

flask-dynamo Documentation

flask-dynamo Documentation flask-dynamo Documentation Release 0.1.2 Randall Degges January 22, 2018 Contents 1 User s Guide 3 1.1 Quickstart................................................ 3 1.2 Getting Help...............................................

More information

Simple libtorrent streaming module Documentation

Simple libtorrent streaming module Documentation Simple libtorrent streaming module Documentation Release 0.1.0 David Francos August 31, 2015 Contents 1 Simple libtorrent streaming module 3 1.1 Dependences...............................................

More information

Python data pipelines similar to R Documentation

Python data pipelines similar to R Documentation Python data pipelines similar to R Documentation Release 0.1.0 Jan Schulz October 23, 2016 Contents 1 Python data pipelines 3 1.1 Features.................................................. 3 1.2 Documentation..............................................

More information

petfinder-api Documentation

petfinder-api Documentation petfinder-api Documentation Release 0.1 Greg Taylor Jun 01, 2017 Contents 1 Assorted Info 3 2 User Guide 5 2.1 Installation................................................ 5 2.1.1 Distribute & Pip.........................................

More information

pyregion Documentation

pyregion Documentation pyregion Documentation Release 2.1.dev336 Jae-Joon Lee Jul 02, 2018 Contents I Documentation 3 i ii Release 2.1.dev336 Date Jul 02, 2018 pyregion is a python module to parse ds9 region files. It also

More information

Ceilometer Documentation

Ceilometer Documentation Ceilometer Documentation Release 0.0 OpenStack, LLC July 06, 2012 CONTENTS 1 What is the purpose of the project and vision for it? 3 2 Table of contents 5 2.1 Initial setup................................................

More information

PyTest Guide. Meher Krishna Patel. Created on : Octorber, 2017 Last updated : May, More documents are freely available at PythonDSP

PyTest Guide. Meher Krishna Patel. Created on : Octorber, 2017 Last updated : May, More documents are freely available at PythonDSP PyTest Guide Meher Krishna Patel Created on : Octorber, 2017 Last updated : May, 2018 More documents are freely available at PythonDSP Table of contents Table of contents i 1 PyTest Guide 2 1.1 Code to

More information

django-cas Documentation

django-cas Documentation django-cas Documentation Release 2.3.6 Parth Kolekar January 17, 2016 Contents 1 django-cas 3 1.1 Documentation.............................................. 3 1.2 Quickstart................................................

More information

contribution-guide.org Release

contribution-guide.org Release contribution-guide.org Release August 06, 2018 Contents 1 About 1 1.1 Sources.................................................. 1 2 Submitting bugs 3 2.1 Due diligence...............................................

More information

doubles Documentation

doubles Documentation doubles Documentation Release 1.1.0 Jimmy Cuadra August 23, 2015 Contents 1 Installation 3 2 Integration with test frameworks 5 2.1 Pytest................................................... 5 2.2 Nose...................................................

More information

Python Project Example Documentation

Python Project Example Documentation Python Project Example Documentation Release 0.1.0 Neil Stoddard Mar 22, 2017 Contents 1 Neilvana Example 3 1.1 Features.................................................. 3 1.2 Credits..................................................

More information

withenv Documentation

withenv Documentation withenv Documentation Release 0.7.0 Eric Larson Aug 02, 2017 Contents 1 withenv 3 2 Installation 5 3 Usage 7 3.1 YAML Format.............................................. 7 3.2 Command Substitutions.........................................

More information

lazy-object-proxy Release 1.3.1

lazy-object-proxy Release 1.3.1 lazy-object-proxy Release 1.3.1 Jun 22, 2017 Contents 1 Overview 1 1.1 Installation................................................ 2 1.2 Documentation.............................................. 2

More information

Django Wordpress API Documentation

Django Wordpress API Documentation Django Wordpress API Documentation Release 0.1.0 Swapps Jun 28, 2017 Contents 1 Django Wordpress API 3 1.1 Documentation.............................................. 3 1.2 Quickstart................................................

More information

python-packaging Documentation

python-packaging Documentation python-packaging Documentation Release 0.1 Scott Torborg Sep 20, 2017 Contents 1 Minimal Structure 3 2 Specifying Dependencies 7 3 Better Package Metadata 9 4 Let There Be Tests 13 5 Command Line Scripts

More information

GuessIt Documentation

GuessIt Documentation GuessIt Documentation Release 0.6.1 Nicolas Wack, Ricard Marxer October 23, 2013 CONTENTS i ii Release v0.6.1 (Installation) GuessIt is a python library that tries to extract as much information as possible

More information

Python Finite State Machine. Release 0.1.5

Python Finite State Machine. Release 0.1.5 Python Finite State Machine Release 0.1.5 Sep 15, 2017 Contents 1 Overview 1 1.1 Installation................................................ 1 1.2 Documentation..............................................

More information

yardstick Documentation

yardstick Documentation yardstick Documentation Release 0.1.0 Kenny Freeman December 30, 2015 Contents 1 yardstick 3 1.1 What is yardstick?............................................ 3 1.2 Features..................................................

More information

S1-IV-Question-Pool Documentation

S1-IV-Question-Pool Documentation S1-IV-Question-Pool Documentation Release 0.1.0 Section-I Sep 25, 2017 Contents 1 How to contribute 3 2 The Prologue 7 3 C Language Questions 9 4 C Language Solutions 11 5 Linux Usage Questions 13 6 Linux

More information

sainsmart Documentation

sainsmart Documentation sainsmart Documentation Release 0.3.1 Victor Yap Jun 21, 2017 Contents 1 sainsmart 3 1.1 Install................................................... 3 1.2 Usage...................................................

More information

DoJSON Documentation. Release Invenio collaboration

DoJSON Documentation. Release Invenio collaboration DoJSON Documentation Release 1.2.0 Invenio collaboration March 21, 2016 Contents 1 About 1 2 Installation 3 3 Documentation 5 4 Testing 7 5 Example 9 5.1 User s Guide...............................................

More information

CERN Web Application Detection

CERN Web Application Detection CERN Web Application Detection Refactoring and release as open source software by Piotr Lizończyk Supervised by Sebastian Łopieński and Dr. Stefan Lüders Summer Students Programme 2015 Geneva, 28. August

More information

cwmon-mysql Release 0.5.0

cwmon-mysql Release 0.5.0 cwmon-mysql Release 0.5.0 October 18, 2016 Contents 1 Overview 1 1.1 Installation................................................ 1 1.2 Documentation.............................................. 1 1.3

More information

turbo-hipster Documentation

turbo-hipster Documentation turbo-hipster Documentation Release 0.1 Joshua Hesketh October 07, 2015 Contents 1 Turbo-hipster 3 1.1 Turbo-hipster and Zuul.......................................... 3 1.2 Typical workflow diagram........................................

More information

Roman Numeral Converter Documentation

Roman Numeral Converter Documentation Roman Numeral Converter Documentation Release 0.1.0 Adrian Cruz October 07, 2014 Contents 1 Roman Numeral Converter 3 1.1 Features.................................................. 3 2 Installation 5

More information

django-sticky-uploads Documentation

django-sticky-uploads Documentation django-sticky-uploads Documentation Release 0.2.0 Caktus Consulting Group October 26, 2014 Contents 1 Requirements/Installing 3 2 Browser Support 5 3 Documentation 7 4 Running the Tests 9 5 License 11

More information

GRADUAL TYPING OF PRODUCTION APPLICATIONS ŁUKASZ LANGA

GRADUAL TYPING OF PRODUCTION APPLICATIONS ŁUKASZ LANGA GRADUAL TYPING OF PRODUCTION APPLICATIONS ŁUKASZ LANGA ŁUKASZ LANGA ambv @ #python fb.me/ambv @llanga lukasz@langa.pl WHAT WE RE GOING TO TALK ABOUT Intro to PEP 484 Why annotate? What s the syntax? Types

More information

django-idioticon Documentation

django-idioticon Documentation django-idioticon Documentation Release 0.0.1 openpolis June 10, 2014 Contents 1 django-idioticon 3 1.1 Documentation.............................................. 3 1.2 Quickstart................................................

More information

pip Documentation Release 1.6.dev1 The pip developers

pip Documentation Release 1.6.dev1 The pip developers pip Documentation Release 1.6.dev1 The pip developers February 11, 2014 Contents i ii User list Dev list Github PyPI User IRC: #pip Dev IRC: #pypa The PyPA recommended tool for installing and managing

More information

Pillaging DVCS Repos Adam Baldwin

Pillaging DVCS Repos Adam Baldwin Pillaging DVCS Repos Adam Baldwin INTRODUCTION Distributed Version Control Systems (DVCS) including Git, Mercurial (HG), and Bazaar (BZR) are becoming increasingly popular and also a convenient method

More information

gedit developer plugins Configuring and extending gedit for development

gedit developer plugins Configuring and extending gedit for development gedit developer plugins Configuring and extending gedit for development What is gedit? gedit is a simple text editor with support for syntax highlighting that can be extended for new uses See https://live.gnome.org/gedit

More information

Brief Contents. Acknowledgments... xv. Introduction Chapter 1: Starting Your Project Chapter 2: Modules, Libraries, and Frameworks...

Brief Contents. Acknowledgments... xv. Introduction Chapter 1: Starting Your Project Chapter 2: Modules, Libraries, and Frameworks... Brief Contents Acknowledgments... xv Introduction... 1 Chapter 1: Starting Your Project.... 5 Chapter 2: Modules, Libraries, and Frameworks... 15 Chapter 3: Documentation and Good API Practice... 33 Chapter

More information

fiscalyear Documentation

fiscalyear Documentation fiscalyear Documentation Release 0.1.0 Adam J. Stewart Apr 17, 2017 User Documentation 1 Basic Usage 3 1.1 FiscalYear................................................ 3 1.2 FiscalQuarter...............................................

More information

virtualenvwrapper Documentation

virtualenvwrapper Documentation virtualenvwrapper Documentation Release 4.8.1.dev7 Doug Hellmann September 16, 2017 Contents 1 Features 3 2 Introduction 5 3 Details 9 3.1 Installation................................................

More information

Release Nicholas A. Del Grosso

Release Nicholas A. Del Grosso wavefront r eaderdocumentation Release 0.1.0 Nicholas A. Del Grosso Apr 12, 2017 Contents 1 wavefront_reader 3 1.1 Features.................................................. 3 1.2 Credits..................................................

More information

Gearthonic Documentation

Gearthonic Documentation Gearthonic Documentation Release 0.2.0 Timo Steidle August 11, 2016 Contents 1 Quickstart 3 2 Contents: 5 2.1 Usage................................................... 5 2.2 API....................................................

More information

Signals Documentation

Signals Documentation Signals Documentation Release 0.1 Yeti November 22, 2015 Contents 1 Quickstart 1 2 What is Signals? 3 3 Contents 5 3.1 Get Started................................................ 5 3.2 Try the Demo Server...........................................

More information

peval Documentation Release Bogdan Opanchuk

peval Documentation Release Bogdan Opanchuk peval Documentation Release 0.1.0 Bogdan Opanchuk January 29, 2016 Contents 1 Introduction 1 2 Implementation details 3 3 Restrictions on functions 5 4 API reference 7 4.1 Core functions..............................................

More information

eventbrite-sdk-python Documentation

eventbrite-sdk-python Documentation eventbrite-sdk-python Documentation Release 3.3.4 Eventbrite December 18, 2016 Contents 1 eventbrite-sdk-python 3 1.1 Installation from PyPI.......................................... 3 1.2 Usage...................................................

More information

ACT-R RPC Interface Documentation. Working Draft Dan Bothell

ACT-R RPC Interface Documentation. Working Draft Dan Bothell AC-R RPC Interface Documentation Working Draft Dan Bothell Introduction his document contains information about a new feature available with the AC-R 7.6 + software. here is now a built-in RPC (remote

More information

spinnerchief Documentation Release 0.1.1

spinnerchief Documentation Release 0.1.1 spinnerchief Documentation Release 0.1.1 April 02, 2014 Contents i ii Spinner Chief is an online service for spinning text (synonym substitution) that creates unique version(s) of existing text. This

More information

django-audiofield Documentation

django-audiofield Documentation django-audiofield Documentation Release 0.8.2 Arezqui Belaid Sep 27, 2017 Contents 1 Introduction 3 1.1 Overview................................................. 3 1.2 Usage...................................................

More information

OpenUpgrade Library Documentation

OpenUpgrade Library Documentation OpenUpgrade Library Documentation Release 0.1.0 Odoo Community Association September 10, 2015 Contents 1 OpenUpgrade Library 3 1.1 Features.................................................. 3 2 Installation

More information

The Impact of Django. Armin Ronacher. djangocon europe 2011

The Impact of Django. Armin Ronacher. djangocon europe 2011 The Impact of Django Armin Ronacher djangocon europe 2011 http://lucumr.pocoo.org/talks/ Traveling to the Past What did the World look like in July of 2005? The Year 2005 The initial release of Django

More information