Metadata-Version: 2.3
Name: jrpytests
Version: 0.1.7
Summary: 
Author: Jumping Rivers
Author-email: info@jumpingrivers.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: flake8 (>=3.9.1,<4.0.0)
Requires-Dist: pytest (>=6.2.5,<7.0.0)
Description-Content-Type: text/markdown

# jrpytests

## Overview

This package contains functions for CI testing of JR python packages and was created using the poetry python package, for more details see

[https://github.com/sdispater/poetry](https://github.com/sdispater/poetry).

jrpytests allows: 

* to run pytest,
* to check coding style (via flake8) in python files, 
* to extract python chunks from Rmd files and check their coding style,
* to check if a directory 'vignettes' exists in appropriate folder and,
* to count pdf files in 'vignettes' and compare to number of Rmd files.

The flake8 configuration file is stored in this package, see

jrpytests/flake8\_config.ini.

## Basic usage

Import the package using

`import jrpytests`.

Run pytest

`jrpytests.runpytests()`.

Run flake8 in python files

`jrpytests.runflake8pythonfiles()`.

Run flake8 in Rmd python chunks

`jrpytests.runflake8rmdpychunks()`.

Check 'vignettes' and number of pdf files in it

`jrpytests.checkvignettespdffiles()`.

