Merge pull request #2 from alexpdev/dev

Release PyBen v0.2.3

Author: alexpdev

MANIFEST.in

@@ -1,13 +1,16 @@
 include LICENSE
-include README.rst
+include README.md
+include .pylintrc
+include .prospector.yml
+include mkdocs.yml
 
 recursive-include pyben *
 recursive-include tests *
 recursive-include assets *
 recursive-include .github *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[cod]
-recursive-exclude docs *
+recursive-include docs *
 recursive-exclude site *
 
-recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif *.json *.md
+recursive-include Makefile make.bat *.jpg *.png *.gif *.json *.md *.ico

Makefile

@@ -47,7 +47,10 @@ clean-build: ## remove build artifacts
 	rm -fr .codacy-coverage
 
 lint: ## check style with flake8
-	black pyben tests
+	black pyben
+	black tests
+	isort pyben
+	isort tests
 	pylint pyben tests
 	pycodestyle pyben tests
 	pydocstyle pyben tests
@@ -68,7 +71,7 @@ coverage: ## check code coverage quickly with the default Python
 
 push: lint docs clean test coverage
 	git add .
-	git commit -m "auto push commit coverage"
+	git commit -m "Updates to testing suit, style linting, bug fixes."
 	git push
 	bash codacy.sh report -r coverage.xml
 

README.md

@@ -1,4 +1,4 @@
-# Pyben v0.2.1
+# Pyben v0.2.3
 
 Small library for encoding/decoding bencode data.
 Pyben Enables fast and easy encoding and decoding of bencoded data.
@@ -8,10 +8,13 @@ Pyben Enables fast and easy encoding and decoding of bencoded data.
 ![GitHub repo size](https://img.shields.io/github/repo-size/alexpdev/pyben)
 ![GitHub contributors](https://img.shields.io/github/license/alexpdev/pyben)
 ![GitHub stars](https://img.shields.io/badge/rating-99-green)
+[![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)
 
 ## Prerequisites
 
-* Python3 installed and enabled
+Python v3.6+
 
 ## Installing PyBen
 
@@ -27,30 +30,43 @@ Using git:
 
 ## Using PyBen
 
-The API is intentionally designed to mimic Python's json module.
+The API is intentionally designed to mimic Python's json and pickle modules.
 
-    >>> fd = "path/to/file"
+    >>> import os
+    >>> import pyben
+    >>> file_path = "path/to/encoded.file"
     >>> data = {"item1": ["item2", 3, [4], {5: "item6"}]}
     >>> encoded = pyben.dumps(data)
     >>> encoded
-    ...    b'd5:item1l5:item2i3eli4eedi5e5:item6eee'
+    ... b'd5:item1l5:item2i3eli4eedi5e5:item6eee'
     >>> decoded = pyben.loads(encoded)
-    ...    {'item1': ['item2', 3, [4], {5: 'item6'}]}
+    >>> decoded
+    ... {'item1': ['item2', 3, [4], {5: 'item6'}]}
+    >>> decoded == data
+    ... True
 
 One key difference is that the 'load' and 'dump' methods accept as arguments,
 string paths or path objects as well as open iobuffer.
 
 For Example this:
 
-    >> with open("encoded.file", "wb") as fd:
-    ...    pyben.dump(data, fd)
-    >> with open("encoded.file", "rb") as fd:
-    ...    decoded = pyben.load(fd)
+    >>> with open(file_path, "wb") as fd:
+    >>>    pyben.dump(decoded, fd)
+    >>> os.path.exists(file_path)
+    ... True
+    >>> with open(file_path, "rb") as fd:
+    >>>    decoded_file = pyben.load(fd)
+    >>> decoded_file == decoded == data
+    ... True
 
 is the same as doing following.
 
-    >>> pyben.dump(data, "encoded.file")
-    >>> decoded = pyben.load("encoded.file")
+    >>> pyben.dump(data, file_path)
+    >>> os.path.exists(file_path)
+    ... True
+    >>> decoded_file = pyben.load(file_path)
+    >>> decoded_file == decoded == data
+    ... True
 
 The full API includes many other functions and classes as well.
 See docs for more full API.

coverage.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" ?>
-<coverage version="5.5" timestamp="1633838575289" lines-valid="1503" lines-covered="344" line-rate="0.2289" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0">
+<coverage version="5.5" timestamp="1633844921303" lines-valid="1503" lines-covered="344" line-rate="0.2289" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0">
 	<!-- Generated by coverage.py: https://coverage.readthedocs.io -->
 	<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
 	<sources>

docs/api/index.html

@@ -1443,14 +1443,11 @@ <h6 id="pyben.classes.Bendecoder.load--returns">Returns</h6>
     <span class="n">decoder</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
     <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">&quot;read&quot;</span><span class="p">):</span>
         <span class="n">data</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
-        <span class="k">return</span> <span class="n">decoder</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
 
-    <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">item</span><span class="p">)</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
+    <span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">item</span><span class="p">)</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
         <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">_fd</span><span class="p">:</span>
             <span class="n">data</span> <span class="o">=</span> <span class="n">_fd</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
-            <span class="k">return</span> <span class="n">decoder</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
-
-    <span class="k">raise</span> <span class="n">FilePathError</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">decoder</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
 </code></pre></div>
         </details>
     </div>
@@ -2507,14 +2504,11 @@ <h5 id="pyben.classes.Bendecoder.load--returns">Returns</h5>
     <span class="n">decoder</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
     <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">&quot;read&quot;</span><span class="p">):</span>
         <span class="n">data</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
-        <span class="k">return</span> <span class="n">decoder</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
 
-    <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">item</span><span class="p">)</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
+    <span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">item</span><span class="p">)</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
         <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">_fd</span><span class="p">:</span>
             <span class="n">data</span> <span class="o">=</span> <span class="n">_fd</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
-            <span class="k">return</span> <span class="n">decoder</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
-
-    <span class="k">raise</span> <span class="n">FilePathError</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">decoder</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
 </code></pre></div>
         </details>
     </div>

docs/index.html

@@ -257,5 +257,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.2.2
-Build Date UTC : 2021-10-10 04:02:44.861098+00:00
+Build Date UTC : 2021-10-10 05:48:30.690289+00:00
 -->

docs/search/search_index.json

@@ -1,6 +1,6 @@
 {
   "name": "pyben",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Small library for encoding/decoding bencode data. Pyben Enables fast and easy encoding and decoding of bencoded data.",
   "directories": {
     "doc": "docs",

docs/sitemap.xml.gz

@@ -38,12 +38,12 @@
 
 """
 
-from pyben import classes, bencode, api
+from pyben import api, bencode, classes
 from pyben.api import dump, dumps, load, loads
-from pyben.bencode import benencode, bendecode
-from pyben.classes import Benencoder, Bendecoder
+from pyben.bencode import bendecode, benencode
+from pyben.classes import Bendecoder, Benencoder
 
-__version__ = "0.2.2"
+__version__ = "0.2.3"
 __author__ = "alexpdev"
 
 __all__ = [