diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..458c50c --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,36 @@ +name: Release + +on: + push: + tags: + - "*" + +jobs: + release: + runs-on: ubuntu-18.04 + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Install build packages + run: python -m pip install -U build + - name: Build packages + run: python -m build + - name: Create Release + uses: softprops/action-gh-release@v1 + with: + files: | + dist/*.tar.gz + dist/*.whl + - name: Install system pkgs + run: sudo apt-get update && sudo apt-get install awscli + - name: Upload to S3 + env: + AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }} + AWS_PACKAGE_BUCKET: ${{ secrets.AWS_PACKAGE_BUCKET }} + AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} + AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + run: for F in dist/*; do /usr/bin/aws s3 cp ${F} s3://${AWS_PACKAGE_BUCKET}/python/ ; done diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..b1643b6 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,22 @@ +name: Run Tests + +on: [push, pull_request] + +jobs: + test: + strategy: + matrix: + python: ['3.6', '3.8'] + platform: [ubuntu-18.04] + runs-on: ${{ matrix.platform }} + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python }} + - name: Install test dependencies + run: python -m pip install -U tox pytest + - name: Test + run: python -m tox -e py diff --git a/.gitignore b/.gitignore index d7c2b72..7079be9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,159 @@ -*.pyc -dist -*.egg-info + +# Created by https://www.toptal.com/developers/gitignore/api/python +# Edit at https://www.toptal.com/developers/gitignore?templates=python + +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintainted in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +# End of https://www.toptal.com/developers/gitignore/api/python diff --git a/README.md b/README.md index ae4adb3..33a3e45 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Camo Client =========== [![Build Status](https://travis-ci.org/sionide21/camo-client.png)](https://travis-ci.org/sionide21/camo-client) -[![Latest Version](https://pypip.in/v/camo-client/badge.png)](https://pypi.python.org/pypi/camo-client/) +[![Latest Version](https://img.shields.io/pypi/v/camo-client.svg)](https://pypi.python.org/pypi/camo-client/) A python client for Github's [Camo image proxy](https://github.com/atmos/camo). diff --git a/camo.py b/camo.py index 47a501c..798c3d8 100644 --- a/camo.py +++ b/camo.py @@ -4,7 +4,6 @@ import re from memoize import mproperty from lxml import html -import six class CamoClient(object): @@ -32,7 +31,10 @@ def _rewrite_image_urls(self, node): def parse_html(self, string): doc = html.fromstring(string.join(['
', '
'])) doc = self._rewrite_image_urls(doc) - return six.ensure_str(b''.join(map(html.tostring, doc))) + # Note: html.tostring deceptively returns bytes, not str + # iterating over a node returns all the tags within that node + # ..if there are none, return the original string + return ''.join([html.tostring(e).decode("utf-8") for e in doc]) or string class Image(object): @@ -46,10 +48,8 @@ def path(self): @mproperty def digest(self): - return hmac.new(six.b(self.key), six.b(self.url), hashlib.sha1).hexdigest() + return hmac.new(self.key.encode("utf-8"), self.url.encode("utf-8"), hashlib.sha1).hexdigest() @mproperty def encoded_url(self): - if six.PY2: - return self.url.encode("hex") - return binascii.hexlify(six.b(self.url)).decode("utf-8") + return binascii.hexlify(self.url.encode("utf-8")).decode("utf-8") diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..374b58c --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +[build-system] +requires = [ + "setuptools>=42", + "wheel" +] +build-backend = "setuptools.build_meta" diff --git a/setup.py b/setup.py index 96d7bfe..49f3548 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ setup( name='camo-client', - version='0.2.1', + version='0.3.0', author='Ben Olive', author_email='sionide21@gmail.com', description="A python client for Github's Camo image proxy", diff --git a/tests/camo_test.py b/tests/camo_test.py index 8bfdffc..d075dc1 100644 --- a/tests/camo_test.py +++ b/tests/camo_test.py @@ -39,3 +39,8 @@ def test_ignores_relative(self): client = CamoClient("https://fakecdn.org/", key="hello") html = """

""" self.assertEqual(client.parse_html(html), html) + + def test_unmarkedup_text(self): + client = CamoClient("https://fakecdn.org/", key="hello") + text = """butts""" + self.assertEqual(client.parse_html(text), text) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..4086b4a --- /dev/null +++ b/tox.ini @@ -0,0 +1,11 @@ +[tox] +envlist = py36, py38 +isolated_build = True + +[testenv] + +deps = + pytest + +commands = + python -m pytest