Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kivy-garden/tickmarker
TickMarker widget, used to mark intervals.
https://github.com/kivy-garden/tickmarker
Last synced: about 1 month ago
JSON representation
TickMarker widget, used to mark intervals.
- Host: GitHub
- URL: https://github.com/kivy-garden/tickmarker
- Owner: kivy-garden
- License: mit
- Created: 2020-02-20T22:24:53.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-19T03:43:04.000Z (almost 3 years ago)
- Last Synced: 2024-11-09T00:49:16.061Z (about 2 months ago)
- Language: Python
- Size: 2.79 MB
- Stars: 4
- Watchers: 9
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Tickmarker
==================================[![Github Build Status](https://github.com/kivy-garden/tickmarker/workflows/Tickmarker/badge.svg)](https://github.com/kivy-garden/tickmarker/actions)
TickMarker widget, used to mark intervals.
See https://kivy-garden.github.io/tickmarker/ for the rendered flower docs.
Please see the garden [instructions](https://kivy-garden.github.io) for how to use kivy garden flowers.
Flower information
-------------------Tickmarker exports the `TickMarker` widget, which places ticks in the center
of the widget so that when combined with another widget e.g. a slider it
marks intervals. TickMarker supports horizontal and vertical orientation,
minor/major ticks and log10 representation.For example, to create a log slider from 0.1 to 10 starting at 1 with
major tick marks at every decade, and minor ticks at every 0.2 decades:from kivy.uix.slider import Slider
from kivy.garden.tickmarker import TickMarker
class TickSlider(Slider, TickMarker):
pass
s = TickSlider(log=True, min_log=.1, max_log=10, value_log=1,
ticks_major=1, ticks_minor=5)Or a linear slider from 10 to 200 starting at 60 with major tick marks at
every 50 units from start, and minor ticks at every 10 unitss = TickSlider(min=10, max=200, value=60, ticks_major=50, ticks_minor=5)
To create a log progress bar from 10 to 1000 starting at 500 with major tick
marks at every decade, and minor ticks at every 0.1 decades::from kivy.uix.progressbar import ProgressBar
from kivy.garden.tickmarker import TickMarker
class TickBar(ProgressBar, TickMarker):
padding = NumericProperty(0)
min = NumericProperty(0)
orientation = OptionProperty('horizontal', options=('horizontal'))
s = TickBar(log=True, min_log=10, max_log=1000, value_log=500,
ticks_major=1, ticks_minor=10)When combining with another widget such as a slider, the widget must have
min, max, value, orientation, and padding fields. See the second example above
as to how you would do this with a ProgressBar. When logarithmic representation
is required you read and write to the numerical fields using `min_log`,
`max_log` and `value_log` instead of `min`, `max`, and `value`.Install
---------To install with pip::
pip install kivy_garden.tickmarker
To build or re-build locally::
PYTHONPATH=.:$PYTHONPATH python setup.py build_ext --inplace
Or to install as editable (package is installed, but can be edited in its original location)::
pip install -e .
CI
--Every push or pull request run the [GitHub Action](https://github.com/kivy-garden/flower/actions) CI.
It tests the code on various OS and also generates wheels that can be released on PyPI upon a
tag. Docs are also generated and uploaded to the repo as well as artifacts of the CI.TODO
-------* add your code
Contributing
--------------Check out our [contribution guide](CONTRIBUTING.md) and feel free to improve the flower.
License
---------This software is released under the terms of the MIT License.
Please see the [LICENSE.txt](LICENSE.txt) file.How to release
===============See the garden [instructions](https://kivy-garden.github.io/#makingareleaseforyourflower) for how to make a new release.