From b30a7bcd7344393a7c7fd94a383f30d5a85b4a6e Mon Sep 17 00:00:00 2001 From: Autumn Date: Mon, 4 Dec 2023 21:27:08 -0800 Subject: [PATCH] [README] add badges --- .github/workflows/release.yml | 2 +- .github/workflows/tests.yml | 2 +- README.rst | 15 +++++++++++++++ 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index caabba3..40a1bbd 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,7 +1,7 @@ # This workflow will install Python dependencies, run tests and lint with a single version of Python # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions -name: On release +name: Release on: push: diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index aa56f2e..3d0433c 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -1,7 +1,7 @@ # This workflow will install Python dependencies, run tests and lint with a single version of Python # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions -name: Test library +name: Tests on: push: diff --git a/README.rst b/README.rst index c2ddf44..8e50197 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,12 @@ Instruct ========== +|Release| +|Style| +|PyPI| + + + A compact, fast object system that can serve as the basis for a DAO model. To that end, instruct uses ``__slots__`` to prevent new attribute addition, properties to control types, event listeners and historical changes, and a Jinja2-driven codegen to keep a pure-Python implementation as fast and as light as possible. @@ -422,3 +428,12 @@ After additions of those. Safety is expensive. Overhead of clearing/setting Test with safeties: 1.29 us Test without safeties: 1.14 us + +.. |PyPI| image:: https://img.shields.io/pypi/v/instruct.svg + :target: https://pypi.python.org/pypi/instruct + +.. |Release| image:: https://github.com/autumnjolitz/instruct/actions/workflows/release.yml/badge.svg + :target: https://github.com/autumnjolitz/instruct/actions/workflows/release.yml + +.. |Style| image:: https://github.com/autumnjolitz/instruct/actions/workflows/style-check.yml/badge.svg + :target: https://github.com/autumnjolitz/instruct/actions/workflows/style-check.yml