drawzero 0.4.4__tar.gz → 0.5.1__tar.gz

{drawzero-0.4.4 → drawzero-0.5.1}/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Sergey Shashkov
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2019 Sergey Shashkov
+
+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.

{drawzero-0.4.4 → drawzero-0.5.1}/MANIFEST.in

@@ -1,8 +1,8 @@
-# Include the README
-include *.rst
-
-# Include the license file
-include LICENSE
-
-# Images
-recursive-include docs *.rst *.png *.gif
+# Include the README
+include *.rst
+
+# Include the license file
+include LICENSE
+
+# Images
+recursive-include docs *.rst *.png *.gif

drawzero-0.5.1/PKG-INFO

@@ -0,0 +1,325 @@
+Metadata-Version: 2.4
+Name: drawzero
+Version: 0.5.1
+Summary: A zero-boilerplate canvas drawing framework for Python 3, based on Pygame.
+Author-email: Sergey Shashkov <sh57@yandex.ru>
+License: MIT
+Project-URL: Homepage, https://github.com/ShashkovS/drawzero
+Project-URL: Documentation, https://drawzero.org/
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Environment :: X11 Applications
+Classifier: Environment :: MacOS X
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: Russian
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mkdocs-static-i18n[material]>=1.3.0
+Requires-Dist: pygame>=2.0.1
+Provides-Extra: dev
+Requires-Dist: setuptools; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocs-static-i18n[material]; extra == "dev"
+Requires-Dist: pymdown-extensions; extra == "dev"
+Requires-Dist: mkdocstrings-python; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+<a href="https://pypi.org/project/drawzero/" target="_blank">
+<img alt="PyPI" src="https://img.shields.io/pypi/v/drawzero">
+</a>
+<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/drawzero">
+<img alt="GitHub" src="https://img.shields.io/github/license/ShashkovS/drawzero">
+<img alt="coverage" src="https://img.shields.io/badge/coverage-90%25-brightgreen">
+</p>
+
+# Draw Zero
+A zero-boilerplate canvas drawing framework for Python 3, based on Pygame.
+
+**[Documentation](https://drawzero.org/)**
+
+
+## Some examples
+
+Here's some neat stuff you can do:
+
+``` python
+# import all
+from drawzero import *
+
+# simple shapes
+fill('#12bbae')
+line('red', (400, 400), (800, 800))
+circle('yellow', (500, 560), 200)
+filled_circle('brown', (500, 500), 20)
+text('red', 'Hello, world!', (300, 200), 72)
+rect('blue', (200, 600), 100, 100)
+filled_rect('orange', (400, 600), 100, 100)
+polygon('white', [(20, 200), (100, 240), (40, 160)])
+filled_polygon('burlywood', 200, 400, 130, 304, 20, 342, 20, 458, 130, 496, )
+```
+
+<img alt="hello world" src="https://raw.githubusercontent.com/ShashkovS/drawzero/master/docs/hello_world.png" width="75%">
+
+# Animation
+
+Animations are also straightforward:
+
+<img alt="planet_animation" src="https://raw.githubusercontent.com/ShashkovS/drawzero/master/docs/planet_animation.gif" width="50%">
+
+``` python
+from drawzero import *
+from math import sin, cos, pi
+
+earth_orbit = 400
+earth_radius = 30
+earth_rot_step = 2 * pi / 360
+moon_orbit = 100
+moon_radius = 10
+moon_rot_step = 2 * pi / 60
+
+i = 0
+while True:
+    i += 1
+    e_x = 500 + earth_orbit * cos(earth_rot_step * i)
+    e_y = 500 + earth_orbit * sin(earth_rot_step * i)
+    m_x = e_x + moon_orbit * cos(moon_rot_step * i)
+    m_y = e_y + moon_orbit * sin(moon_rot_step * i)
+
+    clear()
+    filled_circle(C.red, (500, 500), 100)
+    filled_circle(C.blue, (e_x, e_y), earth_radius)
+    filled_circle(C.yellow, (m_x, m_y), moon_radius)
+    tick()
+```
+
+
+# Point class which acts like 2-d vector and Turtle both
+
+<img alt="transparent.png" src="https://raw.githubusercontent.com/ShashkovS/drawzero/master/docs/ex_05.png" width="50%">
+
+```python
+from drawzero import *
+
+# just coordinates
+A = Pt(100, 100)
+B = Pt(300, 150)
+line(C.red, A, B)
+
+# A point which acts as 2-d vector and as a Turtle
+# Pt(x=0.0, y=0.0, *, heading=0.0)
+#
+# Provides (for a, b — points, k number):
+#   * arithmetic
+#     a+b — vector addition
+#     a-b — vector subtraction
+#     k*a and a*k — multiplication with scalar
+#     abs  — absolute value of a
+#     +a, -a
+
+# arithmetic
+A = Pt(100, 200)
+dx = Pt(50, 5)
+for i in range(10):
+    filled_circle(C.blue, A + dx * i, radius=10)
+
+#   * turtle-style movement
+#     forward — Move the point forward by the specified distance.
+#     backward — Move the point backward by distance.
+#     right — Turn point right by angle degrees.
+#     left — Turn point left by angle degrees.
+#     goto — Move point to an absolute position.
+#     rotate_around — Rotate around given point by angle degrees.
+#     move_towards — Move towards the given point by the specified distance.
+#     reset, home — Move point to the origin - coordinates (0,0), set heading=0
+#     setx — Set the point's first coordinate to x
+#     sety — Set the point's second coordinate to y
+#     setheading — Set the point's heading
+
+A = Pt(100, 300)
+B = Pt(1000, 400)
+for i in range(10):
+    filled_circle(C.green2, A, radius=10)
+    A.move_towards(50, B)
+
+A = Pt(100, 400)
+for i in range(10):
+    filled_circle(C.magenta, A, radius=10)
+    A.left(10).forward(30)
+
+#   * information
+#     position — Return the point's current location (x,y), as a tuple.
+#     x, xcor — Return the point's x coordinate.
+#     y, ycor — Return the point's y coordinate
+#     heading — Return the point's heading
+#     distance — Return the distance between points
+#     towards — Return the angle towards point
+#   * deep copy
+#     copy — a clone of point
+```
+
+
+
+# Transparency
+
+Transparency is also straightforward via alpha parameter or RGBA color:
+
+<img alt="transparent.png" src="https://raw.githubusercontent.com/ShashkovS/drawzero/master/docs/transparent.png" width="50%">
+
+```python
+from drawzero import *
+
+clear()
+fill(C.black)
+
+filled_circle('red', (100, 100), 20)
+filled_circle('blue', (100, 110), 22, alpha=100)  # <-- alpha
+circle('red', (100, 100), 50, line_width=10)
+circle((0, 255, 0, 50), (100, 110), 50, line_width=10)  # <-- RGBA
+...
+```
+
+<details>
+  <summary>Full code for transparency and line width example</summary>
+
+  ``` python
+  from drawzero import *
+
+  clear()
+  fill(C.black)
+
+  filled_circle('red', (100, 100), 20)
+  filled_circle('blue', (100, 110), 22, alpha=100)
+  circle('red', (100, 100), 50, line_width=10)
+  circle((0, 255, 0, 50), (100, 110), 50, line_width=10)
+  filled_rect(C.aquamarine, (200, 100), 100, 40)
+  filled_rect(C.darkmagenta, (210, 110), 100, 40, alpha=80)
+  rect(C.darkgoldenrod, (180, 90), 200, 80, line_width=10)
+  rect(C.hotpink, (190, 90), 200, 90, alpha=180, line_width=10)
+    
+  line('red', 600, 400, 600, 990)
+  image('cat.png', (500, 500))
+  image('cat.png', (500, 800), width=200, alpha=128)
+  image('cat.png', (550, 850), width=200, alpha=128)
+    
+  polygon('yellow', [(20, 300), (100, 340), (40, 260)], line_width=20)
+  polygon((0, 0, 255, 200), [(20, 300), (100, 340), (40, 260)], line_width=15)
+  polygon('red', [(20, 300), (100, 340), (40, 260)])
+    
+  filled_polygon('burlywood', 200, 600, 130, 504, 20, 542, 20, 658, 130, 696)
+  filled_polygon(C.hotpink, 200, 700, 130, 604, 20, 642, 20, 758, 130, 796, alpha=100)
+    
+  line(C.green, (700, 100), (800, 200))
+  line(C.green, (710, 100), (810, 200), line_width=5)
+  line(C.red, (820, 100), (720, 200), line_width=10, alpha=50)
+  line(C.blue, (830, 100), (730, 200), line_width=10, alpha=128)
+  ```
+</details>
+
+
+# Color gradients
+
+<img alt="transparent.png" src="https://raw.githubusercontent.com/ShashkovS/drawzero/master/docs/ex_13.png" width="50%">
+
+```python
+from drawzero import *
+
+
+scale1 = Gradient([C.black, C.white], 0, 1000)
+for x in range(0, 1000, 10):
+    filled_rect(scale1(x), (x, 0), 10, 100)
+text(C.white, 'scale1 = Gradient([C.black, C.white], 0, 1000)', (50, 100), 48, '<^')
+
+scale2 = Gradient([C.green, C.yellow, C.magenta, C.red], 0, 1000)
+for x in range(0, 1000, 10):
+    filled_rect(scale2(x), (x, 200), 10, 100)
+text(C.white, 'scale2 = Gradient([C.green, C.yellow, C.magenta, C.red], 0, 1000)', (50, 300), 32, '<^')
+
+scale3 = Gradient([C.white, C.black, C.red, C.black, C.white], 200, 800)
+for x in range(0, 1000, 10):
+    filled_rect(scale3(x), (x, 400), 10, 100)
+text(C.white, 'scale3 = Gradient([C.white, C.black, C.red, C.black, C.white], 200, 800)', (50, 500), 32, '<^')
+```
+
+
+
+# Keyboard and mouse events
+
+Process keyboard events in two ways: check if key is pressed via `get_keys_pressed()` or run throw `keysdown` or `keysup` events:
+
+``` python
+from drawzero import *
+
+upper_text = 'Typed: '
+SIZE = 20
+x = y = 500 - SIZE // 2
+
+while True:
+    # Mouse buttons events
+    if mousebuttonsdown:
+        x, y = mousebuttonsdown[0].pos
+    # Keys which are still pressed
+    keys = get_keys_pressed()
+    if keys[K.UP] or keys[K.w]:
+        y -= 5
+    if keys[K.DOWN] or keys[K.s]:
+        y += 5
+    if keys[K.LEFT] or keys[K.a]:
+        x -= 5
+    if keys[K.RIGHT] or keys[K.d]:
+        x += 5
+    # Keyboard events
+    for ev in keysdown:
+        if ev.unicode:
+            upper_text += ev.unicode
+
+    # Redraw everything
+    clear()
+    filled_rect(C.red, x, y, SIZE, SIZE)
+    text(C.white, upper_text, (100, 5))
+    filled_circle(C.yellow, mouse_pos(), 3)
+    tick()
+```
+
+<img alt="keyboard_and_mouse_events.gif" src="https://raw.githubusercontent.com/ShashkovS/drawzero/master/docs/keyboard_and_mouse_events.gif" width="50%">
+
+
+
+# Installation
+
+In a Terminal window, type:
+```shell
+pip install drawzero --upgrade --user
+```
+
+
+Or run the following program:
+
+```python
+import os, sys
+python = sys.executable
+user = '--user' if 'venv' not in python and 'virtualenvs' not in python else ''
+cmd = f'"{python}" -m pip install drawzero --upgrade {user}'
+os.system(cmd)
+from drawzero import *
+```
+
+# [Contributing](CONTRIBUTING.md)