Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/domdfcoding/custom_wx_icons_suru

Suru icon theme for wxPython 🐍
https://github.com/domdfcoding/custom_wx_icons_suru

icons iconset python python3 suru wxpython

Last synced: 21 days ago
JSON representation

Suru icon theme for wxPython 🐍

Host: GitHub
URL: https://github.com/domdfcoding/custom_wx_icons_suru
Owner: domdfcoding
License: gpl-3.0
Created: 2020-05-30T07:15:10.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-07-08T09:47:55.000Z (4 months ago)
Last Synced: 2024-10-02T22:46:29.131Z (about 1 month ago)
Topics: icons, iconset, python, python3, suru, wxpython
Language: Python
Homepage: https://custom_wx_icons_suru.readthedocs.io/en/latest
Size: 129 MB
Stars: 0
Watchers: 3
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Authors: AUTHORS

Awesome Lists containing this project

README

        =====================

wx_icons_suru

=====================

.. start short_desc

**Suru icon theme for wxPython 🐍**

.. end short_desc

This package provides a wxPython wxArtProvider class with icons from the Suru Icon Theme.

.. start shields

.. list-table::

	:stub-columns: 1

	:widths: 10 90

	* - Docs

	  - |docs| |docs_check|

	* - Tests

	  - |actions_linux| |actions_windows| |actions_macos|

	* - PyPI

	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|

	* - Activity

	  - |commits-latest| |commits-since| |maintained| |pypi-downloads|

	* - QA

	  - |codefactor| |actions_flake8| |actions_mypy|

	* - Other

	  - |license| |language| |requires|

.. |docs| image:: https://img.shields.io/readthedocs/custom-wx-icons-suru/latest?logo=read-the-docs

	:target: https://custom-wx-icons-suru.readthedocs.io/en/latest

	:alt: Documentation Build Status

.. |docs_check| image:: https://github.com/domdfcoding/custom_wx_icons_suru/workflows/Docs%20Check/badge.svg

	:target: https://github.com/domdfcoding/custom_wx_icons_suru/actions?query=workflow%3A%22Docs+Check%22

	:alt: Docs Check Status

.. |actions_linux| image:: https://github.com/domdfcoding/custom_wx_icons_suru/workflows/Linux/badge.svg

	:target: https://github.com/domdfcoding/custom_wx_icons_suru/actions?query=workflow%3A%22Linux%22

	:alt: Linux Test Status

.. |actions_windows| image:: https://github.com/domdfcoding/custom_wx_icons_suru/workflows/Windows/badge.svg

	:target: https://github.com/domdfcoding/custom_wx_icons_suru/actions?query=workflow%3A%22Windows%22

	:alt: Windows Test Status

.. |actions_macos| image:: https://github.com/domdfcoding/custom_wx_icons_suru/workflows/macOS/badge.svg

	:target: https://github.com/domdfcoding/custom_wx_icons_suru/actions?query=workflow%3A%22macOS%22

	:alt: macOS Test Status

.. |actions_flake8| image:: https://github.com/domdfcoding/custom_wx_icons_suru/workflows/Flake8/badge.svg

	:target: https://github.com/domdfcoding/custom_wx_icons_suru/actions?query=workflow%3A%22Flake8%22

	:alt: Flake8 Status

.. |actions_mypy| image:: https://github.com/domdfcoding/custom_wx_icons_suru/workflows/mypy/badge.svg

	:target: https://github.com/domdfcoding/custom_wx_icons_suru/actions?query=workflow%3A%22mypy%22

	:alt: mypy status

.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/custom_wx_icons_suru/badge.svg

	:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/custom_wx_icons_suru/

	:alt: Requirements Status

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/custom_wx_icons_suru?logo=codefactor

	:target: https://www.codefactor.io/repository/github/domdfcoding/custom_wx_icons_suru

	:alt: CodeFactor Grade

.. |pypi-version| image:: https://img.shields.io/pypi/v/wx_icons_suru

	:target: https://pypi.org/project/wx_icons_suru/

	:alt: PyPI - Package Version

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/wx_icons_suru?logo=python&logoColor=white

	:target: https://pypi.org/project/wx_icons_suru/

	:alt: PyPI - Supported Python Versions

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/wx_icons_suru

	:target: https://pypi.org/project/wx_icons_suru/

	:alt: PyPI - Supported Implementations

.. |wheel| image:: https://img.shields.io/pypi/wheel/wx_icons_suru

	:target: https://pypi.org/project/wx_icons_suru/

	:alt: PyPI - Wheel

.. |license| image:: https://img.shields.io/github/license/domdfcoding/custom_wx_icons_suru

	:target: https://github.com/domdfcoding/custom_wx_icons_suru/blob/master/LICENSE

	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/custom_wx_icons_suru

	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/custom_wx_icons_suru/v0.1.2

	:target: https://github.com/domdfcoding/custom_wx_icons_suru/pulse

	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/custom_wx_icons_suru

	:target: https://github.com/domdfcoding/custom_wx_icons_suru/commit/master

	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2024

	:alt: Maintenance

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/wx_icons_suru

	:target: https://pypi.org/project/wx_icons_suru/

	:alt: PyPI - Downloads

.. end shields

Installation

===============

.. start installation

``wx_icons_suru`` can be installed from PyPI.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install wx_icons_suru

.. end installation

Usage

=======

To use ``wx_icons_suru`` in your application:

.. code-block:: python

	# this package

	from wx_icons_suru import wxSuruIconTheme

	class MyApp(wx.App):

		def OnInit(self):

			wx.ArtProvider.Push(wxSuruIconTheme())

			self.frame = TestFrame(None, wx.ID_ANY)

			self.SetTopWindow(self.frame)

			self.frame.Show()

			return True

And then the icons can be accessed through wx.ArtProvider:

.. code-block:: python

	wx.ArtProvider.GetBitmap("document-new", wx.ART_OTHER, wx.Size(48, 48))

Any `FreeDesktop Icon Theme Specification `_ name can be used.

Currently the ``Client ID`` is not used, so just pass ``wx.ART_OTHER``.