a robust, modern and high performance Python library for generating image from a html string/html file/url build on top of `playwright`
Project description
snap-html
a robust, modern and high performance Python library for generating image from a html string/html file/url build on top of playwright
Highlight
- All Basics, Async ready, Sync support, Fully Typed
- Builtin batch generator for higher performance
- Build on top of the giant
playwright
, simplified of headless browser and driver installation - Accept html/css string, and You can use with
jinja2
for html templating
TODO
- Maybe you would like to add gitmoji to commit names. This is really funny. 😄
For building and deployment:
GitHub
integration.Makefile
for building routines. Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc. More details at Makefile summary).- Dockerfile for your package.
Github Actions
with predefined build workflow as the default CI/CD.- Always up-to-date dependencies with
@dependabot
(You will only enable it). - Automatic drafts of new releases with
Release Drafter
. It creates a list of changes based on labels in mergedPull Requests
. You can see labels (akacategories
) inrelease-drafter.yml
. Works perfectly with Semantic Versions specification.
For creating your open source community:
- Ready-to-use Pull Requests templates and several Issue templates.
- Files such as:
LICENSE
,CONTRIBUTING.md
,CODE_OF_CONDUCT.md
, andSECURITY.md
are generated automatically. Stale bot
that closes abandoned issues after a period of inactivity. (You will only need to setup free plan). Configuration is here.- Semantic Versions specification with
Release Drafter
.
Installation
pip install -U snap-html
or install with Poetry
poetry add snap-html
Then you can run
snap-html --help
snap-html --name Roman
or if installed with Poetry
:
poetry run snap-html --help
poetry run snap-html --name Roman
Makefile usage
Makefile
contains many functions for fast assembling and convenient work.
1. Download Poetry
make download-poetry
2. Install all dependencies and pre-commit hooks
make install
If you do not want to install pre-commit hooks, run the command with the NO_PRE_COMMIT flag:
make install NO_PRE_COMMIT=1
3. Check the security of your code
make check-safety
This command launches a Poetry
and Pip
integrity check as well as identifies security issues with Safety
and Bandit
. By default, the build will not crash if any of the items fail. But you can set STRICT=1
for the entire build, or you can configure strictness for each item separately.
make check-safety STRICT=1
or only for safety
:
make check-safety SAFETY_STRICT=1
multiple
make check-safety PIP_STRICT=1 SAFETY_STRICT=1
List of flags for
check-safety
(can be set to1
or0
):STRICT
,POETRY_STRICT
,PIP_STRICT
,SAFETY_STRICT
,BANDIT_STRICT
.
4. Check the codestyle
The command is similar to check-safety
but to check the code style, obviously. It uses Black
, Darglint
, Isort
, and Mypy
inside.
make check-style
It may also contain the STRICT
flag.
make check-style STRICT=1
List of flags for
check-style
(can be set to1
or0
):STRICT
,BLACK_STRICT
,DARGLINT_STRICT
,ISORT_STRICT
,MYPY_STRICT
.
5. Run all the codestyle formaters
Codestyle uses pre-commit
hooks, so ensure you've run make install
before.
make codestyle
6. Run tests
make test
7. Run all the linters
make lint
the same as:
make test && make check-safety && make check-style
List of flags for
lint
(can be set to1
or0
):STRICT
,POETRY_STRICT
,PIP_STRICT
,SAFETY_STRICT
,BANDIT_STRICT
,BLACK_STRICT
,DARGLINT_STRICT
,ISORT_STRICT
,MYPY_STRICT
.
8. Build docker
make docker
which is equivalent to:
make docker VERSION=latest
More information here.
📈 Releases
You can see the list of available releases on the GitHub Releases page.
We follow Semantic Versions specification.
We use Release Drafter
. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.
For Pull Request this labels are configured, by default:
Label | Title in Releases |
---|---|
enhancement , feature |
🚀 Features |
bug , refactoring , bugfix , fix |
🔧 Fixes & Refactoring |
build , ci , testing |
📦 Build System & CI/CD |
breaking |
💥 Breaking Changes |
documentation |
📝 Documentation |
dependencies |
⬆️ Dependencies updates |
You can update it in release-drafter.yml
.
GitHub creates the bug
, enhancement
, and documentation
labels for you. Dependabot creates the dependencies
label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.
🛡 License
This project is licensed under the terms of the MIT
license. See LICENSE for more details.
📃 Citation
@misc{snap-html,
author = {codustry},
title = {a robust, modern and high performance Python library for generating image from a html string/html file/url build on top of `playwright`},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/codustry/snap-html}}
}
Credits
This project was generated with python-package-template
.
Alternative
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file snap-html-0.2.0.tar.gz
.
File metadata
- Download URL: snap-html-0.2.0.tar.gz
- Upload date:
- Size: 8.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.9.1 Linux/5.4.0-1039-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 399587ad6bc80327cabaa7b68d74e11320f0a0a2918df7651e922d1969f95f2e |
|
MD5 | 134bb7e32fd0439ff3c0ac545b8dd8ba |
|
BLAKE2b-256 | 529f52dae54c0b3eaa346012787a74dcff983f0bbeed067b91f5d003277be5a2 |
File details
Details for the file snap_html-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: snap_html-0.2.0-py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.9.1 Linux/5.4.0-1039-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 185e4f73c4f821f065df0cdfb0391376b7d8e17206024059eaeab561ebaa9284 |
|
MD5 | 9501da15390c34dd47525a12c17a7d63 |
|
BLAKE2b-256 | f3f6c74826a572abe96cf3161d41329eeea85c4c0de1bd9007200c5879ba1bea |