You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Harshad Sharma bf30cd39ab Since we now depend on the interpreter path in installer template,
and because that path isn't shown to users anymore, remove the fanciness.
7 years ago
ci Project skeleton with cookiecutter-pylibrary. 7 years ago
docs Project skeleton with cookiecutter-pylibrary. 7 years ago
examples Since we now depend on the interpreter path in installer template, 7 years ago
src Since we now depend on the interpreter path in installer template, 7 years ago
tests Project skeleton with cookiecutter-pylibrary. 7 years ago
.bumpversion.cfg Project skeleton with cookiecutter-pylibrary. 7 years ago
.cookiecutterrc Project skeleton with cookiecutter-pylibrary. 7 years ago
.coveragerc Project skeleton with cookiecutter-pylibrary. 7 years ago
.editorconfig Project skeleton with cookiecutter-pylibrary. 7 years ago
.gitignore Ignore logs. 7 years ago
.travis.yml Project skeleton with cookiecutter-pylibrary. 7 years ago
AUTHORS.rst Project skeleton with cookiecutter-pylibrary. 7 years ago
CHANGELOG.rst Project skeleton with cookiecutter-pylibrary. 7 years ago
CONTRIBUTING.rst Project skeleton with cookiecutter-pylibrary. 7 years ago
LICENSE Project skeleton with cookiecutter-pylibrary. 7 years ago
MANIFEST.in Project skeleton with cookiecutter-pylibrary. 7 years ago
README.rst Project skeleton with cookiecutter-pylibrary. 7 years ago
setup.cfg Project skeleton with cookiecutter-pylibrary. 7 years ago
setup.py install to qutebrowser's userscripts directory for easy access. 7 years ago
tox.ini Project skeleton with cookiecutter-pylibrary. 7 years ago

README.rst

========
Overview
========

.. start-badges

.. list-table::
    :stub-columns: 1

    * - docs
      - |docs|
    * - tests
      - | |travis|
        |
    * - package
      - | |version| |wheel| |supported-versions| |supported-implementations|
        | |commits-since|

.. |docs| image:: https://readthedocs.org/projects/python-qutescript/badge/?style=flat
    :target: https://readthedocs.org/projects/python-qutescript
    :alt: Documentation Status

.. |travis| image:: https://travis-ci.org/hiway/python-qutescript.svg?branch=master
    :alt: Travis-CI Build Status
    :target: https://travis-ci.org/hiway/python-qutescript

.. |version| image:: https://img.shields.io/pypi/v/qutescript.svg
    :alt: PyPI Package latest release
    :target: https://pypi.python.org/pypi/qutescript

.. |commits-since| image:: https://img.shields.io/github/commits-since/hiway/python-qutescript/v0.1.0.svg
    :alt: Commits since latest release
    :target: https://github.com/hiway/python-qutescript/compare/v0.1.0...master

.. |wheel| image:: https://img.shields.io/pypi/wheel/qutescript.svg
    :alt: PyPI Wheel
    :target: https://pypi.python.org/pypi/qutescript

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/qutescript.svg
    :alt: Supported versions
    :target: https://pypi.python.org/pypi/qutescript

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/qutescript.svg
    :alt: Supported implementations
    :target: https://pypi.python.org/pypi/qutescript


.. end-badges

Painless userscripts for qutebrowser.

* Free software: BSD license

Installation
============

::

    pip install qutescript

Documentation
=============

https://python-qutescript.readthedocs.io/

Development
===========

To run the all tests run::

    tox

Note, to combine the coverage data from all the tox environments run:

.. list-table::
    :widths: 10 90
    :stub-columns: 1

    - - Windows
      - ::

            set PYTEST_ADDOPTS=--cov-append
            tox

    - - Other
      - ::

            PYTEST_ADDOPTS=--cov-append tox