Merge pull request #7 from alexpdev/docs

Bump Version 0.2.7

Author: alexpdev

.deepsource.toml

@@ -1,8 +1,17 @@
 version = 1
 
+test_patterns = [
+  "tests/**",
+  "tests/*.py",
+]
+
 [[analyzers]]
 name = "python"
 enabled = true
 
   [analyzers.meta]
-  runtime_version = "3.x.x"
+  runtime_version = "3.x.x"
+
+[[analyzers]]
+name = "test-coverage"
+enabled = true

.github/workflows/workflow.yml .github/workflows/CI.yml.github/workflows/workflow.yml renamed to .github/workflows/CI.yml

@@ -1,4 +1,4 @@
-name: Workflow for python project
+name: CI
 
 on: [push, pull_request]
 jobs:
@@ -15,8 +15,8 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install coverage pytest toml pylint pycodestyle pydocstyle
-          pip install pytest-cov pytest-pylint
-          pytest --cov --pylint tests
+          pip install pytest-cov pytest-pylint pytest-randomly
+          pytest --cov=tests --cov=pyben --pylint tests
           pycodestyle pyben tests
           pydocstyle pyben tests
 

.gitignore

@@ -4,7 +4,6 @@ autorun.bat
 __pycache__/
 *.py[cod]
 *$py.class
-site/
 # Prerequisites
 *.d
 
@@ -156,9 +155,6 @@ venv.bak/
 # Rope project settings
 .ropeproject
 
-# mkdocs documentation
-/site
-
 # mypy
 .mypy_cache/
 .dmypy.json

.prospector.yml

@@ -4,6 +4,11 @@ doc-warnings: true
 test-warnings: true
 member-warnings: true
 
+bandit:
+  run: true
+  options:
+    config: pyproject.toml
+
 pep257:
   run: true
   disable:
@@ -18,16 +23,13 @@ pep8:
 pylint:
   run: true
 
-bandit:
-  run: true
-
 pyroma:
   run: true
 
 pyflakes:
   run: true
 
 mccabe:
-  run: false
+  run: true
   disable:
-    -MC0001
+    - MC0001

.pylintrc

@@ -52,7 +52,7 @@ confidence=
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
-disable=too-many-instance-attributes,too-few-public-methods,too-many-arguments,redefined-outer-name,invalid-name,unspecified-encoding, protected-access
+disable=too-many-instance-attributes,too-few-public-methods,too-many-arguments,redefined-outer-name,invalid-name,unspecified-encoding,protected-access,import-outside-toplevel
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

MANIFEST.in

@@ -3,14 +3,16 @@ include README.md
 include .pylintrc
 include .prospector.yml
 include mkdocs.yml
+include Makefile
+include pyproject.toml
 
 recursive-include pyben *
 recursive-include tests *
 recursive-include assets *
 recursive-include .github *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[cod]
-recursive-include docs *
-recursive-exclude site *
+recursive-exclude docs *
+recursive-include site *
 
-recursive-include Makefile make.bat *.jpg *.png *.gif *.json *.md *.ico
+recursive-include *.jpg *.png *.gif *.json *.md *.ico

Makefile

@@ -32,6 +32,7 @@ clean-build: ## remove build artifacts
 	rm -fr build/
 	rm -fr dist/
 	rm -fr .eggs/
+	rm -fr **/.pytest_cache
 	rm -fr *.egg-info
 	rm -fr *.egg
 	rm -f **.pyc
@@ -51,11 +52,6 @@ lint: ## check style with flake8
 	black tests
 	isort pyben
 	isort tests
-	pylint pyben tests
-	pycodestyle pyben tests
-	pydocstyle pyben tests
-	pyroma .
-	bandit pyben/*
 	prospector pyben
 	prospector tests
 
@@ -65,7 +61,7 @@ test: ## run tests quickly with the default Python
 push: lint docs clean test
 	git add .
 	git commit -m "$m"
-	git push -u origin dev
+	git push
 	coverage run --source pyben -m pytest tests
 	coverage xml -o coverage.xml
 	bash codacy.sh report -r coverage.xml

README.md

@@ -5,9 +5,11 @@ Pyben Enables fast and easy encoding and decoding of bencoded data.
 
 ![PyBen](./assets/pyben.png)
 
-![GitHub repo size](https://img.shields.io/github/repo-size/alexpdev/pyben)
+---------
+
+![GitHub repo size](https://img.shields.io/github/repo-size/alexpdev/pyben&style=flat-square)
 ![GitHub contributors](https://img.shields.io/github/license/alexpdev/pyben)
-![GitHub stars](https://img.shields.io/badge/rating-99-green)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/pyben?color=%23CC3919&label=PyPi%20Downloads&logo=PyPi&logoColor=cyan&style=flat-square)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/af86338dcf0a4a899228df470d20e894)](https://www.codacy.com/gh/alexpdev/pyben/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexpdev/pyben&utm_campaign=Badge_Grade)
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/af86338dcf0a4a899228df470d20e894)](https://www.codacy.com/gh/alexpdev/pyben/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexpdev/pyben&utm_campaign=Badge_Coverage)
 [![codecov](https://codecov.io/gh/alexpdev/pyben/branch/master/graph/badge.svg?token=N6TCUUQ6CJ)](https://codecov.io/gh/alexpdev/pyben)