Welcome to QuteChartjs’s documentation!

QuteChartjs

Use Chart.js from python using QtWebEngine

• Free software: GNU General Public License v3
• Documentation: https://QuteChartjs.readthedocs.io.

Features

• TODO

Credits

This package was created with Cookiecutter and the elgertam/cookiecutter-pipenv project template, based on audreyr/cookiecutter-pypackage.

Installation

Stable release

To install QuteChartjs, run this command in your terminal:

$ pip install QuteChartjs

This is the preferred method to install QuteChartjs, 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.

From sources

The sources for QuteChartjs can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/eyllanesc/QuteChartjs

Or download the tarball:

$ curl  -OL https://github.com/eyllanesc/QuteChartjs/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use QuteChartjs in a project:

import QuteChartjs

QuteChartjs

QuteChartjs package

Subpackages

QuteChartjs.internals package

Submodules

QuteChartjs.internals.QtSiteConfig module

QuteChartjs.internals.QtSiteConfig.update_members(members)

Module contents

exception QuteChartjs.internals.BindingError

Bases: Exception

Submodules

QuteChartjs.charts module

class QuteChartjs.charts.ChartjsNode(id_: str, type_: str, page: PyQt5.QtWebEngineWidgets.QWebEnginePage)

Bases: QuteChartjs.core.RootNode

data

execute(script: str, *, callback: Callable[[Any], None] = None, kwargs: Dict[str, Any] = None, synchronous: bool = False) → None

id

type

QuteChartjs.cli module

Console script for QuteChartjs.

QuteChartjs.common module

class QuteChartjs.common.AnimationNode(parent)

Bases: QuteChartjs.core.ChartNode

duration

easing

class QuteChartjs.common.DataNode(parent)

Bases: QuteChartjs.core.ChartNode

labels

class QuteChartjs.common.HoverNode(parent)

Bases: QuteChartjs.core.ChartNode

animationDuration

axis

intersect

mode

class QuteChartjs.common.LayoutNode(parent)

Bases: QuteChartjs.core.ChartNode

padding

class QuteChartjs.common.TitleNode(parent)

Bases: QuteChartjs.core.ChartNode

display

fontColor

fontFamily

fontSize

position

text

QuteChartjs.core module

class QuteChartjs.core.ChartNode(name: str = '', parent: Optional[QuteChartjs.core.Node] = None)

Bases: QuteChartjs.core.Node

fullname() → str

page

class QuteChartjs.core.Node(name: str, parent=None)

Bases: object

name

parent

root

class QuteChartjs.core.QtEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: json.encoder.JSONEncoder

default(obj)

Implement this method in a subclass such that it returns a serializable object for o, or calls the base implementation (to raise a TypeError).

For example, to support arbitrary iterators, you could implement default like this:

def default(self, o):
    try:
        iterable = iter(o)
    except TypeError:
        pass
    else:
        return list(iterable)
    # Let the base class default method raise the TypeError
    return JSONEncoder.default(self, o)

class QuteChartjs.core.RootNode(name: str = '')

Bases: QuteChartjs.core.ChartNode

execute(script: str, *, callback: Callable[[Any], None] = None, kwargs: Dict[str, Any] = None, synchronous: bool = False) → None

class QuteChartjs.core.javascript_property(*args, **kw)

Bases: property_manager.writable_property

QuteChartjs.globals module

class QuteChartjs.globals.GlobalNode(page: PyQt5.QtWebEngineWidgets.QWebEnginePage)

Bases: QuteChartjs.core.RootNode

animation

execute(script: str, *, callback: Callable[[Any], None] = None, kwargs: Dict[str, Any] = None, synchronous: bool = False) → None

hover

layout

title

Module contents

Top-level package for QuteChartjs.

class QuteChartjs.Chartjs

Bases: object

charts_ = []

classmethod create_chart(id_, type_, page)

classmethod global_(page)

globals_ = []

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/eyllanesc/QuteChartjs/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

QuteChartjs could always use more documentation, whether as part of the official QuteChartjs docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/eyllanesc/QuteChartjs/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up QuteChartjs for local development.

1. Fork the QuteChartjs repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/QuteChartjs.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv QuteChartjs
   $ cd QuteChartjs/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 QuteChartjs tests
   $ python setup.py test or py.test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/eyllanesc/QuteChartjs/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_QuteChartjs

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

• Edwin Yllanes <e.yllanescucho@gmail.com>

Contributors

None yet. Why not be the first?

History

0.1.0 (2019-10-31)

• First release on PyPI.

Indices and tables

• Index
• Module Index
• Search Page