diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ef61d8f --- /dev/null +++ b/.gitignore @@ -0,0 +1,62 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# 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/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# PyCharm files +.idea/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..dcb691c --- /dev/null +++ b/.travis.yml @@ -0,0 +1,28 @@ +# Config file for automatic testing at travis-ci.org +# This file will be regenerated if you run travis_pypi_setup.py + +language: python +python: 3.5 + +env: + - TOXENV=py35 + - TOXENV=py27 + +# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors +install: pip install -U tox + +# command to run tests, e.g. python setup.py test +script: tox -e ${TOXENV} + +# After you create the Github repo and add it to Travis, run the +# travis_pypi_setup.py script to finish PyPI deployment setup +deploy: + provider: pypi + distributions: sdist bdist_wheel + user: fogo + password: + secure: PLEASE_REPLACE_ME + on: + tags: true + repo: fogo/qt_style_sheet_inspector + condition: $TOXENV == py27 diff --git a/HISTORY.rst b/HISTORY.rst new file mode 100644 index 0000000..f355d1b --- /dev/null +++ b/HISTORY.rst @@ -0,0 +1,8 @@ +======= +History +======= + +0.1.0 (2016-09-28) +------------------ + +* First release. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7b2e92b --- /dev/null +++ b/LICENSE @@ -0,0 +1,11 @@ + +MIT License + +Copyright (c) 2016, Rafael Bertoldi + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..1ee9e93 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,10 @@ + +include HISTORY.rst +include LICENSE +include README.rst + +recursive-include tests * +recursive-exclude * __pycache__ +recursive-exclude * *.py[co] + +recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d1ae2d0 --- /dev/null +++ b/README.rst @@ -0,0 +1,21 @@ +======================== +Qt Style Sheet Inspector +======================== + +.. image:: https://img.shields.io/travis/fogo/qt_style_sheet_inspector.svg + :target: https://travis-ci.org/fogo/qt_style_sheet_inspector + + +A inspector widget to view and modify style sheet of a Qt app in runtime. + + +* Free software: MIT license + + +Features +-------- + +* Can view current style sheet of application during runtime +* Style sheet can be changed in runtime, facilitating the process of designing a custom GUI +* Has a search bar to help find specific types or names +* Can undo/redo changes diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..07d4772 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/qt_style_sheet_inspector.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/qt_style_sheet_inspector.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/qt_style_sheet_inspector" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/qt_style_sheet_inspector" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..0608dad --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,275 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# qt_style_sheet_inspector documentation build configuration file, created by +# sphinx-quickstart on Tue Jul 9 22:26:36 2013. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another +# directory, add these directories to sys.path here. If the directory is +# relative to the documentation root, use os.path.abspath to make it +# absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# Get the project root dir, which is the parent dir of this +cwd = os.getcwd() +project_root = os.path.dirname(cwd) + +# Insert the project root dir as the first element in the PYTHONPATH. +# This lets us ensure that the source package is imported, and that its +# version is used. +sys.path.insert(0, project_root) + +import qt_style_sheet_inspector + +# -- General configuration --------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Qt Style Sheet Inspector' +copyright = u"2016, Rafael Bertoldi" + +# The version info for the project you're documenting, acts as replacement +# for |version| and |release|, also used in various other places throughout +# the built documents. +# +# The short X.Y version. +version = qt_style_sheet_inspector.__version__ +# The full version, including alpha/beta/rc tags. +release = qt_style_sheet_inspector.__version__ + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to +# some non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built +# documents. +#keep_warnings = False + + +# -- Options for HTML output ------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a +# theme further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as +# html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the +# top of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon +# of the docs. This file should be a Windows icon file (.ico) being +# 16x16 or 32x32 pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) +# here, relative to this directory. They are copied after the builtin +# static files, so a file named "default.css" will overwrite the builtin +# "default.css". +# html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names +# to template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. +# Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. +# Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages +# will contain a tag referring to it. The value of this option +# must be the base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'qt_style_sheet_inspectordoc' + + +# -- Options for LaTeX output ------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + #'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', 'qt_style_sheet_inspector.tex', + u'Qt Style Sheet Inspector Documentation', + u'Rafael Bertoldi', 'manual'), +] + +# The name of an image file (relative to this directory) to place at +# the top of the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings +# are parts, not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output ------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'qt_style_sheet_inspector', + u'Qt Style Sheet Inspector Documentation', + [u'Rafael Bertoldi'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ---------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'qt_style_sheet_inspector', + u'Qt Style Sheet Inspector Documentation', + u'Rafael Bertoldi', + 'qt_style_sheet_inspector', + 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/history.rst b/docs/history.rst new file mode 100644 index 0000000..2506499 --- /dev/null +++ b/docs/history.rst @@ -0,0 +1 @@ +.. include:: ../HISTORY.rst diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..65d8a6a --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,24 @@ +.. qt_style_sheet_inspector documentation master file, created by + sphinx-quickstart on Tue Jul 9 22:26:36 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Qt Style Sheet Inspector's documentation! +====================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + readme + installation + usage + history + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..fd2e923 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,51 @@ +.. highlight:: shell + +============ +Installation +============ + + +Stable release +-------------- + +To install Qt Style Sheet Inspector, run this command in your terminal: + +.. code-block:: console + + $ pip install qt_style_sheet_inspector + +This is the preferred method to install Qt Style Sheet Inspector, as it will always install the most recent stable release. + +If you don't have `pip`_ installed, this `Python installation guide`_ can guide +you through the process. + +.. _pip: https://pip.pypa.io +.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ + + +From sources +------------ + +The sources for Qt Style Sheet Inspector can be downloaded from the `Github repo`_. + +You can either clone the public repository: + +.. code-block:: console + + $ git clone git://github.com/fogo/qt_style_sheet_inspector + +Or download the `tarball`_: + +.. code-block:: console + + $ curl -OL https://github.com/fogo/qt_style_sheet_inspector/tarball/master + +Once you have a copy of the source, you can install it with: + +.. code-block:: console + + $ python setup.py install + + +.. _Github repo: https://github.com/fogo/qt_style_sheet_inspector +.. _tarball: https://github.com/fogo/qt_style_sheet_inspector/tarball/master diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..76fd0d9 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,242 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\qt_style_sheet_inspector.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\qt_style_sheet_inspector.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/docs/readme.rst b/docs/readme.rst new file mode 100644 index 0000000..72a3355 --- /dev/null +++ b/docs/readme.rst @@ -0,0 +1 @@ +.. include:: ../README.rst diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000..0d4a4c9 --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,7 @@ +===== +Usage +===== + +To use Qt Style Sheet Inspector in a project:: + + import qt_style_sheet_inspector diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000..b387fec --- /dev/null +++ b/environment.yml @@ -0,0 +1,11 @@ +name: qt_style_sheet_inspector + +dependencies: + - pyqt5>=5.5 + - pytest + - pytest-mock + - pytest-qt + +environment: + - PYTHONPATH: + - {{ root }} diff --git a/qt_style_sheet_inspector/__init__.py b/qt_style_sheet_inspector/__init__.py new file mode 100644 index 0000000..6fd5da5 --- /dev/null +++ b/qt_style_sheet_inspector/__init__.py @@ -0,0 +1,9 @@ +# -*- coding: utf-8 -*- + +from __future__ import absolute_import, division, print_function, unicode_literals + +from ._inspector import StyleSheetInspector + +__version__ = '0.1.0' + +__all__ = ['StyleSheetInspector'] diff --git a/qt_style_sheet_inspector/_inspector.py b/qt_style_sheet_inspector/_inspector.py new file mode 100644 index 0000000..ae6a2d6 --- /dev/null +++ b/qt_style_sheet_inspector/_inspector.py @@ -0,0 +1,221 @@ +# -*- coding: utf-8 -*- + +from __future__ import absolute_import, division, print_function, unicode_literals + +from textwrap import dedent + +from PyQt5.QtCore import QEvent, Qt +from PyQt5.QtGui import QKeySequence, QTextCursor +from PyQt5.QtWidgets import ( + QDialog, QHBoxLayout, QLineEdit, QMessageBox, QPushButton, QShortcut, QTextEdit, QVBoxLayout, + QWidget, qApp) + + +class StyleSheetInspector(QDialog): + """ + An inspector window that tries to aid developers inspecting current style sheet used by a + Qt application. + + It provides a few features: + + * a search bar to search for occurrences in style sheet + * apply style sheet changes to app in run time, without the necessity of + regenerating Qt resource files for every change in QSS, which can speed the design of a + style sheet a lot. + * undo/redo of applied style sheets + + Press `F1` to see all available shortcuts. + + About code style + ---------------- + + Since it is an specialization of a Qt widget, it reuses its code style so its API is + consistent. + + Known issues + ------------ + + * Inspector window still reuses app style sheet, which can be annoying when testing styles. + Is there a way to avoid reusing style sheets? + + Reference + --------- + + Inspired by http://doc.qt.io/qt-5/qtwidgets-widgets-stylesheet-example.html. + """ + + def __init__(self, parent=None): + QDialog.__init__(self, parent) + + self.setWindowTitle('Qt Style Sheet Inspector') + self.widget = StyleSheetWidget() + + layout = QHBoxLayout() + layout.addWidget(self.widget) + self.setLayout(layout) + + def event(self, event): + """ + Overridden to show shortcuts on `?` button of dialog. + """ + if event.type() == QEvent.EnterWhatsThisMode: + from PyQt5.QtWidgets import QWhatsThis + QWhatsThis.leaveWhatsThisMode() + self.widget.onHelp() + return True + return QDialog.event(self, event) + + +class StyleSheetWidget(QWidget): + + def __init__(self, parent=None): + QWidget.__init__(self, parent) + self.tape = [] + self.tape_pos = -1 + + self.style_sheet = None + + self.search_bar = QLineEdit(self) + self.search_bar.textChanged.connect(self.onSearchTextChanged) + + self.style_text_edit = QTextEdit(self) + self.style_text_edit.textChanged.connect(self.onStyleTextChanged) + # To prevent messing with contents when pasted from an IDE, for instance. + self.style_text_edit.setAcceptRichText(False) + + self.apply_button = QPushButton('Apply', self) + self.apply_button.clicked.connect(self.onApplyButton) + + layout = QVBoxLayout(self) + layout.addWidget(self.search_bar) + layout.addWidget(self.style_text_edit) + layout.addWidget(self.apply_button) + self.setLayout(layout) + + next_hit_shortcut = QShortcut(QKeySequence(Qt.Key_F3), self) + next_hit_shortcut.activated.connect(self.onNextSearchHit) + + search_shortcut = QShortcut(QKeySequence(Qt.CTRL + Qt.Key_F), self) + search_shortcut.activated.connect(self.onFocusSearchBar) + + apply_shortcut = QShortcut(QKeySequence(Qt.CTRL + Qt.Key_S), self) + apply_shortcut.activated.connect(self.applyStyleSheet) + + undo_shortcut = QShortcut(QKeySequence(Qt.CTRL + Qt.ALT + Qt.Key_Z), self) + undo_shortcut.activated.connect(self.onUndo) + + redo_shortcut = QShortcut(QKeySequence(Qt.CTRL + Qt.ALT + Qt.Key_Y), self) + redo_shortcut.activated.connect(self.onRedo) + + help_shortcut = QShortcut(QKeySequence(Qt.Key_F1), self) + help_shortcut.activated.connect(self.onHelp) + + self.loadStyleSheet() + + def onUndo(self, checked=False): + """ + Undo last applied style sheet, if there is any. + """ + assert self.tape_pos >= 0 + if self.tape_pos == 0: + return + self.tape_pos -= 1 + self.style_text_edit.setPlainText(self.tape[self.tape_pos]) + self.applyStyleSheet(stateless=True) + + def onRedo(self, checked=False): + """ + Redo last reverted style sheet, if there is any. + """ + assert self.tape_pos >= 0 + if self.tape_pos == len(self.tape) - 1: + return + self.tape_pos += 1 + self.style_text_edit.setPlainText(self.tape[self.tape_pos]) + self.applyStyleSheet(stateless=True) + + def onHelp(self): + """ + Shows a dialog with available shortcuts. + """ + msg_box = QMessageBox(self) + msg_box.setWindowTitle("Help") + msg_box.setText("Available shortcuts:") + msg_box.setInformativeText(dedent("""\ + F1: show help dialog + Ctrl+S: apply current changes + Ctrl+F: go to search bar + F3: go to next search hit + Ctrl+Alt+Z: revert to last applied style sheet + Ctrl+Alt+Y: redo last reverted style sheet + """)) + msg_box.setStandardButtons(QMessageBox.Ok) + msg_box.setDefaultButton(QMessageBox.Ok) + msg_box.exec_() + + def onSearchTextChanged(self, text): + """ + When search bar text changes, try to find text in style sheet text. If there is a match, + color search bar text green, otherwise goes back to start of style sheet text and text + is colored red. + """ + search = self.search_bar.text() + if not self.style_text_edit.find(search): + self.search_bar.setStyleSheet("color: red;") + self.style_text_edit.moveCursor(QTextCursor.Start) + else: + self.search_bar.setStyleSheet("color: green;") + + def onNextSearchHit(self): + """ + Goes to next match to search text. If there isn't any, cycles back to first occurrence. + """ + search = self.search_bar.text() + if not self.style_text_edit.find(search): + # Cycle back to first hit + self.style_text_edit.moveCursor(QTextCursor.Start) + self.style_text_edit.find(search) + + def onFocusSearchBar(self): + """ + Focus search bar. + """ + self.search_bar.setFocus() + + def onStyleTextChanged(self): + """ + Enable apply button when there are style text changes. + """ + self.apply_button.setEnabled(True) + + def onApplyButton(self, checked=False): + """ + Apply style sheet changes in running app when apply button pressed. + """ + self.applyStyleSheet() + + def loadStyleSheet(self): + """ + Load app style sheet and displays its text in inspector widget. + """ + style_sheet = self.style_sheet = qApp.styleSheet() + self.tape.append(style_sheet) + self.tape_pos = 0 + + self.style_text_edit.setPlainText(style_sheet) + self.apply_button.setEnabled(False) + + def applyStyleSheet(self, stateless=False): + """ + Apply style sheet changes in running app. + + :param bool stateless: If true, style sheet state tape isn't updated. + """ + self.style_sheet = self.style_text_edit.toPlainText() + qApp.setStyleSheet(self.style_sheet) + if not stateless: + if self.tape_pos + 1 < len(self.tape): + self.tape = self.tape[:self.tape_pos + 1] + self.tape.append(self.style_sheet) + self.tape_pos += 1 + self.apply_button.setEnabled(False) diff --git a/requirements_dev.txt b/requirements_dev.txt new file mode 100644 index 0000000..e1dae6c --- /dev/null +++ b/requirements_dev.txt @@ -0,0 +1,11 @@ +pip==8.1.2 +bumpversion==0.5.3 +wheel==0.29.0 +watchdog==0.8.3 +flake8==2.6.0 +tox==2.3.1 +coverage==4.1 +Sphinx==1.4.4 +cryptography==1.4 +PyYAML==3.11 +pytest==2.9.2 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..33be860 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,18 @@ +[bumpversion] +current_version = 0.1.0 +commit = True +tag = True + +[bumpversion:file:setup.py] +search = version='{current_version}' +replace = version='{new_version}' + +[bumpversion:file:qt_style_sheet_inspector/__init__.py] +search = __version__ = '{current_version}' +replace = __version__ = '{new_version}' + +[bdist_wheel] +universal = 1 + +[flake8] +exclude = docs diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..87d44ae --- /dev/null +++ b/setup.py @@ -0,0 +1,52 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +from setuptools import setup + +with open('README.rst') as readme_file: + readme = readme_file.read() + +with open('HISTORY.rst') as history_file: + history = history_file.read() + +requirements = [ + 'PyQt5', +] + +test_requirements = [ + 'pytest', + 'pytest-qt', + 'pytest-mock', +] + +setup( + name='qt_style_sheet_inspector', + version='0.1.0', + description="A inspector widget to view and modify style sheet of a Qt app in runtime.", + long_description=readme + '\n\n' + history, + author="Rafael Bertoldi", + author_email='tochaman@gmail.com', + url='https://github.com/ESSS/qt_style_sheet_inspector', + packages=[ + 'qt_style_sheet_inspector', + ], + package_dir={'qt_style_sheet_inspector': + 'qt_style_sheet_inspector'}, + include_package_data=True, + install_requires=requirements, + license="MIT license", + zip_safe=False, + keywords='qt_style_sheet_inspector', + classifiers=[ + 'Development Status :: 2 - Pre-Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: MIT License', + 'Natural Language :: English', + "Programming Language :: Python :: 2", + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.5', + ], + test_suite='tests', + tests_require=test_requirements +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..40a96af --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1 @@ +# -*- coding: utf-8 -*- diff --git a/tests/test_qt_style_sheet_inspector.py b/tests/test_qt_style_sheet_inspector.py new file mode 100644 index 0000000..b6a4d8a --- /dev/null +++ b/tests/test_qt_style_sheet_inspector.py @@ -0,0 +1,171 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +from __future__ import absolute_import, division, print_function, unicode_literals + +import pytest +from PyQt5.QtCore import Qt +from PyQt5.QtTest import QTest +from PyQt5.QtWidgets import qApp +from qt_style_sheet_inspector import StyleSheetInspector + + +def test_load_style_sheet(inspector): + """ + :type inspector: alfasim_gui.gui.style_sheet_inspector.StyleSheetInspector + """ + assert inspector.widget.style_text_edit.toPlainText() == qApp.styleSheet() + + +def test_apply(inspector): + """ + :type inspector: alfasim_gui.gui.style_sheet_inspector.StyleSheetInspector + """ + assert not inspector.widget.apply_button.isEnabled() + inspector.widget.style_text_edit.setPlainText(qApp.styleSheet() + """\ + QLabel { + font-size: 14px; + } + """) + assert inspector.widget.apply_button.isEnabled() + inspector.widget.apply_button.click() + assert inspector.widget.style_text_edit.toPlainText() == qApp.styleSheet() + assert not inspector.widget.apply_button.isEnabled() + + +def test_search_hit(inspector): + """ + :type inspector: alfasim_gui.gui.style_sheet_inspector.StyleSheetInspector + """ + # keyClick only works if window is shown + inspector.show() + + assert inspector.widget.style_text_edit.textCursor().position() == 0 + + # there are 3 occurrences of "0px" in style sheet, after that it should cycle back to first + # occurrence + inspector.widget.search_bar.setText("0px") + assert inspector.widget.search_bar.styleSheet() == "color: green;" + assert inspector.widget.style_text_edit.textCursor().position() == 35 + + QTest.keyClick(inspector.widget, Qt.Key_F3, delay=50) + assert inspector.widget.search_bar.styleSheet() == "color: green;" + assert inspector.widget.style_text_edit.textCursor().position() == 61 + + QTest.keyClick(inspector.widget, Qt.Key_F3, delay=50) + assert inspector.widget.search_bar.styleSheet() == "color: green;" + assert inspector.widget.style_text_edit.textCursor().position() == 86 + + QTest.keyClick(inspector.widget, Qt.Key_F3, delay=50) + assert inspector.widget.search_bar.styleSheet() == "color: green;" + assert inspector.widget.style_text_edit.textCursor().position() == 35 + + +def test_search_miss(inspector): + """ + :type inspector: alfasim_gui.gui.style_sheet_inspector.StyleSheetInspector + """ + # keyClick only works if window is shown + inspector.show() + + assert inspector.widget.style_text_edit.textCursor().position() == 0 + + inspector.widget.search_bar.setText("INVALID") + assert inspector.widget.search_bar.styleSheet() == "color: red;" + assert inspector.widget.style_text_edit.textCursor().position() == 0 + + QTest.keyClick(inspector.widget, Qt.Key_F3, delay=50) + assert inspector.widget.search_bar.styleSheet() == "color: red;" + assert inspector.widget.style_text_edit.textCursor().position() == 0 + + +def test_focus_search_bar(inspector, mocker): + """ + :type inspector: alfasim_gui.gui.style_sheet_inspector.StyleSheetInspector + :type mocker: pytest_mock.MockFixture + """ + # keyClick only works if window is shown + inspector.show() + + # testing focus is unreliable, especially when using multiprocessing + mocker.patch.object(inspector.widget.search_bar, 'setFocus') + + QTest.keyClick(inspector.widget, Qt.Key_F, Qt.ControlModifier, delay=50) + inspector.widget.search_bar.setFocus.assert_called_once_with() + + +def test_undo_redo(inspector): + """ + :type inspector: alfasim_gui.gui.style_sheet_inspector.StyleSheetInspector + """ + # keyClick only works if window is shown + inspector.show() + + style_sheets = [qApp.styleSheet()] + + # Undo before changes doesn't have any effect + QTest.keyClick(inspector.widget, Qt.Key_Z, Qt.ControlModifier | Qt.AltModifier, delay=50) + assert inspector.widget.style_text_edit.toPlainText() == style_sheets[-1] + + # Undo after changes + inspector.widget.style_text_edit.setPlainText(qApp.styleSheet() + """\ + QLabel { + font-size: 14px; + } + """) + inspector.widget.apply_button.click() + current = qApp.styleSheet() + assert inspector.widget.style_text_edit.toPlainText() == current + assert current != style_sheets[-1] + style_sheets.append(current) + + QTest.keyClick(inspector.widget, Qt.Key_Z, Qt.ControlModifier | Qt.AltModifier, delay=50) + assert inspector.widget.style_text_edit.toPlainText() == style_sheets[-2] + + # Redo + QTest.keyClick(inspector.widget, Qt.Key_Y, Qt.ControlModifier | Qt.AltModifier, delay=50) + assert inspector.widget.style_text_edit.toPlainText() == style_sheets[-1] + + # Redo again, won't have any effect + QTest.keyClick(inspector.widget, Qt.Key_Y, Qt.ControlModifier | Qt.AltModifier, delay=50) + assert inspector.widget.style_text_edit.toPlainText() == style_sheets[-1] + + # Undo, change again then try to redo, won't have any effect, as state tape has been updated + QTest.keyClick(inspector.widget, Qt.Key_Z, Qt.ControlModifier | Qt.AltModifier, delay=50) + inspector.widget.style_text_edit.setPlainText(qApp.styleSheet() + """\ + QPushButton { + background-color: #dcdddf; + } + """) + inspector.widget.apply_button.click() + current = qApp.styleSheet() + assert inspector.widget.style_text_edit.toPlainText() == current + assert current != style_sheets[-1] + style_sheets.append(current) + + QTest.keyClick(inspector.widget, Qt.Key_Y, Qt.ControlModifier | Qt.AltModifier, delay=50) + assert inspector.widget.style_text_edit.toPlainText() == style_sheets[-1] + + +@pytest.fixture +def initial_qss(): + return """\ + * { + margin: 0px; + padding: 0px; + border: 0px; + font-family: "Century Gothic"; + } + """ + + +@pytest.fixture +def inspector(qtbot, initial_qss): + """ + :type qtbot: pytestqt.plugin.QtBot + """ + qApp.setStyleSheet(initial_qss) + + inspector_ = StyleSheetInspector() + qtbot.addWidget(inspector_) + return inspector_ diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..02a28bc --- /dev/null +++ b/tox.ini @@ -0,0 +1,22 @@ +[tox] +envlist = py27, py35, flake8 + +[testenv:flake8] +basepython=python +deps=flake8 +commands=flake8 qt_style_sheet_inspector + +[testenv] +setenv = + PYTHONPATH = {toxinidir}:{toxinidir}/qt_style_sheet_inspector +deps = + -r{toxinidir}/requirements_dev.txt +commands = + pip install -U pip + py.test --basetemp={envtmpdir} + + +; If you want to make tox run the tests with the same versions, create a +; requirements.txt with the pinned versions and uncomment the following lines: +; deps = +; -r{toxinidir}/requirements.txt diff --git a/travis_pypi_setup.py b/travis_pypi_setup.py new file mode 100644 index 0000000..5c38cff --- /dev/null +++ b/travis_pypi_setup.py @@ -0,0 +1,124 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +"""Update encrypted deploy password in Travis config file +""" + + +from __future__ import print_function + +import base64 +import json +import os +from getpass import getpass + +import yaml + +from cryptography.hazmat.backends import default_backend +from cryptography.hazmat.primitives.asymmetric.padding import PKCS1v15 +from cryptography.hazmat.primitives.serialization import load_pem_public_key + +try: + from urllib import urlopen +except: + from urllib.request import urlopen + + +GITHUB_REPO = 'fogo/qt_style_sheet_inspector' +TRAVIS_CONFIG_FILE = os.path.join( + os.path.dirname(os.path.abspath(__file__)), '.travis.yml') + + +def load_key(pubkey): + """Load public RSA key, with work-around for keys using + incorrect header/footer format. + + Read more about RSA encryption with cryptography: + https://cryptography.io/latest/hazmat/primitives/asymmetric/rsa/ + """ + try: + return load_pem_public_key(pubkey.encode(), default_backend()) + except ValueError: + # workaround for https://github.com/travis-ci/travis-api/issues/196 + pubkey = pubkey.replace('BEGIN RSA', 'BEGIN').replace('END RSA', 'END') + return load_pem_public_key(pubkey.encode(), default_backend()) + + +def encrypt(pubkey, password): + """Encrypt password using given RSA public key and encode it with base64. + + The encrypted password can only be decrypted by someone with the + private key (in this case, only Travis). + """ + key = load_key(pubkey) + encrypted_password = key.encrypt(password, PKCS1v15()) + return base64.b64encode(encrypted_password) + + +def fetch_public_key(repo): + """Download RSA public key Travis will use for this repo. + + Travis API docs: http://docs.travis-ci.com/api/#repository-keys + """ + keyurl = 'https://api.travis-ci.org/repos/{0}/key'.format(repo) + data = json.loads(urlopen(keyurl).read().decode()) + if 'key' not in data: + errmsg = "Could not find public key for repo: {}.\n".format(repo) + errmsg += "Have you already added your GitHub repo to Travis?" + raise ValueError(errmsg) + return data['key'] + + +def prepend_line(filepath, line): + """Rewrite a file adding a line to its beginning. + """ + with open(filepath) as f: + lines = f.readlines() + + lines.insert(0, line) + + with open(filepath, 'w') as f: + f.writelines(lines) + + +def load_yaml_config(filepath): + with open(filepath) as f: + return yaml.load(f) + + +def save_yaml_config(filepath, config): + with open(filepath, 'w') as f: + yaml.dump(config, f, default_flow_style=False) + + +def update_travis_deploy_password(encrypted_password): + """Update the deploy section of the .travis.yml file + to use the given encrypted password. + """ + config = load_yaml_config(TRAVIS_CONFIG_FILE) + + config['deploy']['password'] = dict(secure=encrypted_password) + + save_yaml_config(TRAVIS_CONFIG_FILE, config) + + line = ('# This file was autogenerated and will overwrite' + ' each time you run travis_pypi_setup.py\n') + prepend_line(TRAVIS_CONFIG_FILE, line) + + +def main(args): + public_key = fetch_public_key(args.repo) + password = args.password or getpass('PyPI password: ') + update_travis_deploy_password(encrypt(public_key, password.encode())) + print("Wrote encrypted password to .travis.yml -- you're ready to deploy") + + +if '__main__' == __name__: + import argparse + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument('--repo', default=GITHUB_REPO, + help='GitHub repo (default: %s)' % GITHUB_REPO) + parser.add_argument('--password', + help='PyPI password (will prompt if not provided)') + + args = parser.parse_args() + main(args)