Metadata-Version: 2.4
Name: func-sketch
Version: 0.3.0
Summary: A graphing calculator currently in development.
Keywords: graphing calculator,mathematics
Author-Email: Kenta Kabashima <kenta_program37@hotmail.co.jp>
License-Expression: Apache-2.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Typing :: Typed
Project-URL: homepage, https://funcsketch.musicscience37.com/
Project-URL: source, https://gitlab.com/MusicScience37Projects/tools/func-sketch
Project-URL: documentation, https://funcsketch.musicscience37.com/
Project-URL: issues, https://gitlab.com/MusicScience37Projects/tools/func-sketch/-/work_items
Requires-Python: <3.14,>=3.13
Requires-Dist: numpy<3.0.0,>=2.5.3
Requires-Dist: kivy[base]<3.0.0,>=2.3.1
Requires-Dist: scipy<2.0.0,>=1.18.1
Requires-Dist: rapidfuzz<4.0.0,>=3.14.6
Description-Content-Type: text/markdown

# FuncSketch

![icon](https://funcsketch.musicscience37.com/icon.svg)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/func_sketch)
[![PyPI - Version](https://img.shields.io/pypi/v/func_sketch)](https://pypi.org/project/func_sketch/)
![PyPI - License](https://img.shields.io/pypi/l/func_sketch)
[![pipeline status](https://gitlab.com/MusicScience37Projects/tools/func-sketch/badges/main/pipeline.svg)](https://gitlab.com/MusicScience37Projects/tools/func-sketch/-/commits/main)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![coverage report](https://gitlab.com/MusicScience37Projects/tools/func-sketch/badges/main/coverage.svg)](https://gitlab.com/MusicScience37Projects/tools/func-sketch/-/commits/main)
![Scc Count Badge](https://sloc.xyz/github/MusicScience37/FuncSketch/?lower=true&category=lines)

A graphing calculator currently in development.

This project aims to provide:

- real-time graphing of functions
- support for a wide range of mathematical functions,
  from basic ones like trigonometric functions to special functions such as Bessel functions.

## Supported Platforms

- Currently, only Linux and Windows with `x86_64` architecture is supported officially.
  - Other platforms / architectures may work because the software is written in a cross-platform manner, but no tests are conducted for them.
- Supported Python version is only 3.13.
  - Python 3.14 will be supported after a dependent Python package `Kivy` supports it.

## Installation

Packages are available via PyPI:

```bash
pip install func_sketch
```

## Documentation

Available at [FuncSketch Documentation](https://funcsketch.musicscience37.com/).
Documentation of different versions can be seen using the version selector on the bottom left corner of the documentation page.

## Repositories

- [Main repository in GitLab](https://gitlab.com/MusicScience37Projects/tools/func-sketch)
- [Mirror in GitHub](https://github.com/MusicScience37/FuncSketch)

## License

This project is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
Outputs of the project such as generated image files are not in the scope of the license, and can be used freely without any restrictions.

Some helper scripts used only for development are licensed under the MIT license.

## Links for Developers

- [Coverage of C++](https://funcsketch.musicscience37.com/coverage_cpp/)
- [Coverage of Python](https://funcsketch.musicscience37.com/coverage_python/)
- [FuncSketch on SonarQube](https://sonarcloud.io/project/overview?id=MusicScience37Projects_func-sketch)
