From 1aebfaf5944dade1008667e139b62994f8b5c74a Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 12:03:19 -0400 Subject: [PATCH 01/18] Add logging for debug info --- adafruit_turtle.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/adafruit_turtle.py b/adafruit_turtle.py index e194bc7..ac6235a 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -26,6 +26,7 @@ import gc import math import time +import adafruit_logging as logging class Color: WHITE = 0xFFFFFF @@ -86,6 +87,8 @@ def __repr__(self): class turtle: def __init__(self, display=board.DISPLAY): + self._logger = logging.getLogger("Turtle") + self._logger.setLevel(logging.DEBUG) self._display = display self._w = self._display.width self._h = self._display.height @@ -142,7 +145,7 @@ def __init__(self, display=board.DISPLAY): def _drawturtle(self): self._turtle_sprite.x = int(self._x - 4) self._turtle_sprite.y = int(self._y - 4) - #print("pos (%d, %d)" % (self._x, self._y)) + #self._logger.debug("pos (%d, %d)", self._x, self._y) # Turtle motion def forward(self, distance): @@ -173,7 +176,7 @@ def goto(self, x1, y1=None): y1 = self._h//2 - y1 x0 = self._x y0 = self._y - print("* GoTo from", x0, y0, "to", x1, y1) + self._logger.debug("* GoTo from (%d, %d) to (%d, %d)", x0, y0, x1, y1) if not self.isdown(): self._x = x1 # woot, we just skip ahead self._y = y1 From 44a851904fdcc4292a466bb10e2efef5cf8dfb99 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 12:03:59 -0400 Subject: [PATCH 02/18] Updates for library name and fix color references --- examples/turtle_benzene.py | 2 +- examples/turtle_square.py | 4 ++-- examples/turtle_star.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/turtle_benzene.py b/examples/turtle_benzene.py index e1ce8c4..cf09bf9 100644 --- a/examples/turtle_benzene.py +++ b/examples/turtle_benzene.py @@ -1,5 +1,5 @@ import board -from Adafruit_CircuitPython_turtle.adafruit_turtle import * +from adafruit_turtle import * turtle = turtle(board.DISPLAY) benzsize = min(board.DISPLAY.width, board.DISPLAY.height) * 0.5 diff --git a/examples/turtle_square.py b/examples/turtle_square.py index 4ba876a..adf7c95 100644 --- a/examples/turtle_square.py +++ b/examples/turtle_square.py @@ -1,10 +1,10 @@ import board -from Adafruit_CircuitPython_turtle.adafruit_turtle import * +from adafruit_turtle import * turtle = turtle(board.DISPLAY) print("Turtle time! Lets draw a simple square") -turtle.pencolor(color.WHITE) +turtle.pencolor(Color.WHITE) print("Position:", turtle.pos()) print("Heading:", turtle.heading()) diff --git a/examples/turtle_star.py b/examples/turtle_star.py index 00fa4c7..39fe33c 100644 --- a/examples/turtle_star.py +++ b/examples/turtle_star.py @@ -1,5 +1,5 @@ import board -from Adafruit_CircuitPython_turtle.adafruit_turtle import * +from adafruit_turtle import * turtle = turtle(board.DISPLAY) starsize = min(board.DISPLAY.width, board.DISPLAY.height) * 0.9 # 90% of screensize From 88b7248604e41089665c00f8669b9469b3148898 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 12:05:14 -0400 Subject: [PATCH 03/18] Make formatting more consistent --- adafruit_turtle.py | 60 +++++++++++++++++++++++++--------------------- 1 file changed, 33 insertions(+), 27 deletions(-) diff --git a/adafruit_turtle.py b/adafruit_turtle.py index ac6235a..1d0e46b 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -56,30 +56,39 @@ class Vec2D(tuple): """ def __init__(cls, x, y): super().__init__((x, y)) + def __add__(self, other): - return Vec2D(self[0]+other[0], self[1]+other[1]) + return Vec2D(self[0] + other[0], self[1] + other[1]) + def __mul__(self, other): if isinstance(other, Vec2D): - return self[0]*other[0]+self[1]*other[1] - return Vec2D(self[0]*other, self[1]*other) + return self[0] * other[0]+self[1] * other[1] + return Vec2D(self[0] * other, self[1] * other) + def __rmul__(self, other): if isinstance(other, int) or isinstance(other, float): - return Vec2D(self[0]*other, self[1]*other) + return Vec2D(self[0] * other, self[1] * other) + def __sub__(self, other): - return Vec2D(self[0]-other[0], self[1]-other[1]) + return Vec2D(self[0] - other[0], self[1] - other[1]) + def __neg__(self): return Vec2D(-self[0], -self[1]) + def __abs__(self): return (self[0]**2 + self[1]**2)**0.5 + def rotate(self, angle): """rotate self counterclockwise by angle """ perp = Vec2D(-self[1], self[0]) angle = angle * math.pi / 180.0 c, s = math.cos(angle), math.sin(angle) - return Vec2D(self[0]*c+perp[0]*s, self[1]*c+perp[1]*s) + return Vec2D(self[0] * c + perp[0] * s, self[1] * c + perp[1] * s) + def __getnewargs__(self): return (self[0], self[1]) + def __repr__(self): return "(%.2f,%.2f)" % self @@ -92,8 +101,8 @@ def __init__(self, display=board.DISPLAY): self._display = display self._w = self._display.width self._h = self._display.height - self._x = self._w//2 - self._y = self._h//2 + self._x = self._w // 2 + self._y = self._h // 2 self._speed = 6 self._heading = 90 self._logomode = False @@ -109,10 +118,10 @@ def __init__(self, display=board.DISPLAY): self._splash.append(self._bg_sprite) self._fg_bitmap = displayio.Bitmap(self._w, self._h, 5) - self._fg_palette = displayio.Palette(len(Color.colors)+1) + self._fg_palette = displayio.Palette(len(Color.colors) + 1) self._fg_palette.make_transparent(0) for i,c in enumerate(Color.colors): - self._fg_palette[i+1] = c + self._fg_palette[i + 1] = c self._fg_sprite = displayio.TileGrid(self._fg_bitmap, pixel_shader=self._fg_palette, x=0, y=0) @@ -123,10 +132,10 @@ def __init__(self, display=board.DISPLAY): self._turtle_palette.make_transparent(0) self._turtle_palette[1] = Color.WHITE for i in range(4): - self._turtle_bitmap[4-i, i] = 1 - self._turtle_bitmap[i, 4+i] = 1 - self._turtle_bitmap[4+i, 7-i] = 1 - self._turtle_bitmap[4+i, i] = 1 + self._turtle_bitmap[4 - i, i] = 1 + self._turtle_bitmap[i, 4 + i] = 1 + self._turtle_bitmap[4 + i, 7 - i] = 1 + self._turtle_bitmap[4 + i, i] = 1 self._turtle_sprite = displayio.TileGrid(self._turtle_bitmap, pixel_shader=self._turtle_palette, x=-100, y=-100) @@ -150,8 +159,8 @@ def _drawturtle(self): # Turtle motion def forward(self, distance): p = self.pos() - x1 = p[0] + math.sin(math.radians(self._heading))*distance - y1 = p[1] + math.cos(math.radians(self._heading))*distance + x1 = p[0] + math.sin(math.radians(self._heading)) * distance + y1 = p[1] + math.cos(math.radians(self._heading)) * distance self.goto(x1, y1) fd = forward @@ -172,8 +181,8 @@ def goto(self, x1, y1=None): if y1 is None: y1 = x1[1] x1 = x1[0] - x1 += self._w//2 - y1 = self._h//2 - y1 + x1 += self._w // 2 + y1 = self._h // 2 - y1 x0 = self._x y0 = self._y self._logger.debug("* GoTo from (%d, %d) to (%d, %d)", x0, y0, x1, y1) @@ -270,26 +279,24 @@ def speed(self, speed=None): #################### # Tell turtle's state def pos(self): - return Vec2D(self._x - self._w//2, self._h//2 - self._y) + return Vec2D(self._x - self._w // 2, self._h // 2 - self._y) position=pos def clear(self): for w in range(self._w): for h in range(self._h): self._fg_bitmap[w, h] = 0 - for i,c in enumerate(Color.colors): - self._fg_palette[i+1] = c^0xFFFFFF + for i, c in enumerate(Color.colors): + self._fg_palette[i + 1] = c ^ 0xFFFFFF self._display.refresh_soon() - for i,c in enumerate(Color.colors): - self._fg_palette[i+1] = c + for i, c in enumerate(Color.colors): + self._fg_palette[i + 1] = c self._display.refresh_soon() time.sleep(0.1) - def heading(self): return self._heading - # Pen control def pendown(self): self._penstate = True @@ -309,8 +316,6 @@ def pencolor(self, c): raise RuntimeError("Color must be one of the 'color' class items") self._pencolor = 1 + Color.colors.index(c) - - def mode(self, mode=None): if mode == "standard": self._logomode = False @@ -323,6 +328,7 @@ def mode(self, mode=None): return "standard" else: raise RuntimeError("Mode must be 'logo' or 'standard!'") + def _turn(self, angle): if self._logomode: self._heading -= angle From 1d1b111ef3802d1da5e0cdb71c1dd10dafe09eea Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 12:05:46 -0400 Subject: [PATCH 04/18] Add cookiecutter output --- .gitignore | 12 + .pylintrc | 433 ++++++++++++++++++++++++++++++++++ .readthedocs.yml | 3 + .travis.yml | 48 ++++ CODE_OF_CONDUCT.md | 127 ++++++++++ LICENSE | 21 ++ README.rst | 120 ++++++++++ adafruit_turtle.py | 57 ++++- docs/_static/favicon.ico | Bin 0 -> 4414 bytes docs/api.rst | 8 + docs/conf.py | 160 +++++++++++++ docs/examples.rst | 8 + docs/index.rst | 51 ++++ examples/turtle_simpletest.py | 23 ++ requirements.txt | 2 + setup.py | 64 +++++ 16 files changed, 1124 insertions(+), 13 deletions(-) create mode 100644 .gitignore create mode 100644 .pylintrc create mode 100644 .readthedocs.yml create mode 100644 .travis.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 docs/_static/favicon.ico create mode 100644 docs/api.rst create mode 100644 docs/conf.py create mode 100644 docs/examples.rst create mode 100644 docs/index.rst create mode 100644 examples/turtle_simpletest.py create mode 100644 requirements.txt create mode 100644 setup.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..55f127b --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +*.mpy +.idea +__pycache__ +_build +*.pyc +.env +build* +bundles +*.DS_Store +.eggs +dist +**/*.egg-info \ No newline at end of file diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..039eaec --- /dev/null +++ b/.pylintrc @@ -0,0 +1,433 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +# jobs=1 +jobs=2 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio).You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +# notes=FIXME,XXX,TODO +notes=FIXME,XXX + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules=board + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,future.builtins + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +# expected-line-ending-format= +expected-line-ending-format=LF + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming hint for argument names +argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct argument names +argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for attribute names +attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct attribute names +attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class names +# class-name-hint=[A-Z_][a-zA-Z0-9]+$ +class-name-hint=[A-Z_][a-zA-Z0-9_]+$ + +# Regular expression matching correct class names +# class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-rgx=[A-Z_][a-zA-Z0-9_]+$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming hint for function names +function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct function names +function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Good variable names which should always be accepted, separated by a comma +# good-names=i,j,k,ex,Run,_ +good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for method names +method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct method names +method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming hint for variable names +variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +# max-attributes=7 +max-attributes=11 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=1 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..f4243ad --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: requirements.txt diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..9885816 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,48 @@ +# This is a common .travis.yml for generating library release zip files for +# CircuitPython library releases using circuitpython-build-tools. +# See https://github.com/adafruit/circuitpython-build-tools for detailed setup +# instructions. + +dist: xenial +language: python +python: + - "3.6" + +cache: + pip: true + +# TODO: if deployment to PyPi is desired, change 'DEPLOY_PYPI' to "true", +# or remove the env block entirely and remove the condition in the +# deploy block. +env: + - DEPLOY_PYPI="false" + +deploy: + - provider: releases + api_key: "$GITHUB_TOKEN" + file_glob: true + file: "$TRAVIS_BUILD_DIR/bundles/*" + skip_cleanup: true + overwrite: true + on: + tags: true + # TODO: Use 'travis encrypt --com -r adafruit/' to generate + # the encrypted password for adafruit-travis. Paste result below. + - provider: pypi + user: adafruit-travis + password: + secure: #-- PASTE ENCRYPTED PASSWORD HERE --# + on: + tags: true + condition: $DEPLOY_PYPI = "true" + +install: + - pip install -r requirements.txt + - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme + - pip install --force-reinstall pylint==1.9.2 + +script: + - pylint adafruit_turtle.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-turtle --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7ca3a1d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Adafruit Community Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and leaders pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level or type of +experience, education, socio-economic status, nationality, personal appearance, +race, religion, or sexual identity and orientation. + +## Our Standards + +We are committed to providing a friendly, safe and welcoming environment for +all. + +Examples of behavior that contributes to creating a positive environment +include: + +* Be kind and courteous to others +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Collaborating with other community members +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and sexual attention or advances +* The use of inappropriate images, including in a community member's avatar +* The use of inappropriate language, including in a community member's nickname +* Any spamming, flaming, baiting or other attention-stealing behavior +* Excessive or unwelcome helping; answering outside the scope of the question + asked +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate + +The goal of the standards and moderation guidelines outlined here is to build +and maintain a respectful community. We ask that you don’t just aim to be +"technically unimpeachable", but rather try to be your best self. + +We value many things beyond technical expertise, including collaboration and +supporting others within our community. Providing a positive experience for +other community members can have a much more significant impact than simply +providing the correct answer. + +## Our Responsibilities + +Project leaders are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project leaders have the right and responsibility to remove, edit, or +reject messages, comments, commits, code, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any community member for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Moderation + +Instances of behaviors that violate the Adafruit Community Code of Conduct +may be reported by any member of the community. Community members are +encouraged to report these situations, including situations they witness +involving other community members. + +You may report in the following ways: + +In any situation, you may send an email to . + +On the Adafruit Discord, you may send an open message from any channel +to all Community Helpers by tagging @community moderators. You may also send an +open message from any channel, or a direct message to @kattni#1507, +@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or +@Andon#8175. + +Email and direct message reports will be kept confidential. + +In situations on Discord where the issue is particularly egregious, possibly +illegal, requires immediate action, or violates the Discord terms of service, +you should also report the message directly to Discord. + +These are the steps for upholding our community’s standards of conduct. + +1. Any member of the community may report any situation that violates the +Adafruit Community Code of Conduct. All reports will be reviewed and +investigated. +2. If the behavior is an egregious violation, the community member who +committed the violation may be banned immediately, without warning. +3. Otherwise, moderators will first respond to such behavior with a warning. +4. Moderators follow a soft "three strikes" policy - the community member may +be given another chance, if they are receptive to the warning and change their +behavior. +5. If the community member is unreceptive or unreasonable when warned by a +moderator, or the warning goes unheeded, they may be banned for a first or +second offense. Repeated offenses will result in the community member being +banned. + +## Scope + +This Code of Conduct and the enforcement policies listed above apply to all +Adafruit Community venues. This includes but is not limited to any community +spaces (both public and private), the entire Adafruit Discord server, and +Adafruit GitHub repositories. Examples of Adafruit Community spaces include +but are not limited to meet-ups, audio chats on the Adafruit Discord, or +interaction at a conference. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. As a community +member, you are representing our community, and are expected to behave +accordingly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at +, +and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). + +For other projects adopting the Adafruit Community Code of +Conduct, please contact the maintainers of those projects for enforcement. +If you wish to use this code of conduct for your own project, consider +explicitly mentioning your moderation policy or making a copy with your +own moderation policy so as to avoid confusion. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4556147 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2019 LadyAda and Dave Astels for Adafruit Industries + +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. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..2a60f49 --- /dev/null +++ b/README.rst @@ -0,0 +1,120 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-turtle/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/turtle/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord + +.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_turtle.svg?branch=master + :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_turtle + :alt: Build Status + +Turtle graphics library for CircuitPython and displayio + + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ +* `Bus Device `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +Installing from PyPI +===================== +.. note:: This library is not available on PyPI yet. Install documentation is included + as a standard element. Stay tuned for PyPI availability! + +.. todo:: Remove the above note if PyPI version is/will be available at time of release. + If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section. + +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-turtle + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-turtle + +To install in a virtual environment in your current project: + +.. code-block:: shell + + mkdir project-name && cd project-name + python3 -m venv .env + source .env/bin/activate + pip3 install adafruit-circuitpython-turtle + +Usage Example +============= + +.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Building locally +================ + +Zip release files +----------------- + +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install circuitpython-build-tools + +Once installed, make sure you are in the virtual environment: + +.. code-block:: shell + + source .env/bin/activate + +Then run the build: + +.. code-block:: shell + + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-turtle --library_location . + +Sphinx documentation +----------------------- + +Sphinx is used to build the documentation based on rST files and comments in the code. First, +install dependencies (feel free to reuse the virtual environment from above): + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install Sphinx sphinx-rtd-theme + +Now, once you have the virtual environment activated: + +.. code-block:: shell + + cd docs + sphinx-build -E -W -b html . _build/html + +This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to +view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to +locally verify it will pass. diff --git a/adafruit_turtle.py b/adafruit_turtle.py index 1d0e46b..55d9d1f 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -3,23 +3,51 @@ # Copyright (C) 2006 - 2010 Gregor Lingl # email: glingl@aon.at # -# This software is provided 'as-is', without any express or implied -# warranty. In no event will the authors be held liable for any damages -# arising from the use of this software. +# The MIT License (MIT) # -# Permission is granted to anyone to use this software for any purpose, -# including commercial applications, and to alter it and redistribute it -# freely, subject to the following restrictions: +# Copyright (c) 2019 LadyAda and Dave Astels for Adafruit Industries # -# 1. The origin of this software must not be misrepresented; you must not -# claim that you wrote the original software. If you use this software -# in a product, an acknowledgment in the product documentation would be -# appreciated but is not required. -# 2. Altered source versions must be plainly marked as such, and must not be -# misrepresented as being the original software. -# 3. This notice may not be removed or altered from any source distribution. +# 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. +""" +`adafruit_turtle` +================================================================================ + +Turtle graphics library for CircuitPython and displayio + + +* Author(s): LadyAda and Dave Astels +Implementation Notes +-------------------- +**Hardware:** + +.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered list & hyperlink rST + inline format: "* `Link Text `_" + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice +""" import displayio import board @@ -28,6 +56,9 @@ import time import adafruit_logging as logging +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_turtle.git" + class Color: WHITE = 0xFFFFFF BLACK = 0x0000 diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..5aca98376a1f7e593ebd9cf41a808512c2135635 GIT binary patch literal 4414 zcmd^BX;4#F6n=SG-XmlONeGrD5E6J{RVh+e928U#MG!$jWvO+UsvWh`x&VqGNx*en zx=qox7Dqv{kPwo%fZC$dDwVpRtz{HzTkSs8QhG0)%Y=-3@Kt!4ag|JcIo?$-F|?bXVS9UDUyev>MVZQ(H8K4#;BQW-t2CPorj8^KJrMX}QK zp+e<;4ldpXz~=)2GxNy811&)gt-}Q*yVQpsxr@VMoA##{)$1~=bZ1MmjeFw?uT(`8 z^g=09<=zW%r%buwN%iHtuKSg|+r7HkT0PYN*_u9k1;^Ss-Z!RBfJ?Un4w(awqp2b3 z%+myoFis_lTlCrGx2z$0BQdh+7?!JK#9K9@Z!VrG zNj6gK5r(b4?YDOLw|DPRoN7bdP{(>GEG41YcN~4r_SUHU2hgVtUwZG@s%edC;k7Sn zC)RvEnlq~raE2mY2ko64^m1KQL}3riixh?#J{o)IT+K-RdHae2eRX91-+g!y`8^># z-zI0ir>P%Xon)!@xp-BK2bDYUB9k613NRrY6%lVjbFcQc*pRqiK~8xtkNPLxt}e?&QsTB}^!39t_%Qb)~Ukn0O%iC;zt z<&A-y;3h++)>c1br`5VFM~5(83!HKx$L+my8sW_c#@x*|*vB1yU)_dt3vH;2hqPWx zAl^6@?ipx&U7pf`a*>Yq6C85nb+B=Fnn+(id$W#WB^uHAcZVG`qg;rWB}ubvi(Y>D z$ei>REw$#xp0SHAd^|1hq&9HJ=jKK8^zTH~nk)G?yUcmTh9vUM6Y0LMw4(gYVY$D$ zGl&WY&H<)BbJ&3sYbKjx1j^=3-0Q#f^}(aP1?8^`&FUWMp|rmtpK)bLQ1Zo?^s4jqK=Lfg*9&geMGVQ z#^-*!V`fG@;H&{M9S8%+;|h&Qrxym0Ar>WT4BCVLR8cGXF=JmEYN(sNT(9vl+S|%g z8r7nXQ(95i^`=+XHo|){$vf2$?=`F$^&wFlYXyXg$B{a>$-Fp+V}+D;9k=~Xl~?C4 zAB-;RKXdUzBJE{V&d&%R>aEfFe;vxqI$0@hwVM}gFeQR@j}a>DDxR+n+-*6|_)k%% z*mSpDV|=5I9!&VC&9tD%fcVygWZV!iIo2qFtm#!*(s|@ZT33*Ad;+<|3^+yrp*;oH zBSYLV(H1zTU?2WjrCQoQW)Z>J2a=dTriuvezBmu16`tM2fm7Q@d4^iqII-xFpwHGI zn9CL}QE*1vdj2PX{PIuqOe5dracsciH6OlAZATvE8rj6ykqdIjal2 z0S0S~PwHb-5?OQ-tU-^KTG@XNrEVSvo|HIP?H;7ZhYeZkhSqh-{reE!5di;1zk$#Y zCe7rOnlzFYJ6Z#Hm$GoidKB=2HBCwm`BbZVeZY4ukmG%1uz7p2URs6c9j-Gjj^oQV zsdDb3@k2e`C$1I5ML5U0Qs0C1GAp^?!*`=|Nm(vWz3j*j*8ucum2;r0^-6Aca=Gv) zc%}&;!+_*S2tlnnJnz0EKeRmw-Y!@9ob!XQBwiv}^u9MkaXHvM=!<3YX;+2#5Cj5pp?FEK750S3BgeSDtaE^ zXUM@xoV6yBFKfzvY20V&Lr0yC + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/turtle_simpletest.py b/examples/turtle_simpletest.py new file mode 100644 index 0000000..39fe33c --- /dev/null +++ b/examples/turtle_simpletest.py @@ -0,0 +1,23 @@ +import board +from adafruit_turtle import * + +turtle = turtle(board.DISPLAY) +starsize = min(board.DISPLAY.width, board.DISPLAY.height) * 0.9 # 90% of screensize + +print("Turtle time! Lets draw a star") + +turtle.pencolor(Color.BLUE) + +turtle.penup() +turtle.goto(-starsize/2, 0) +turtle.pendown() + +start = turtle.pos() +while True: + turtle.forward(starsize) + turtle.left(170) + if abs(turtle.pos() - start) < 1: + break + +while True: + pass diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3031961 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +Adafruit-Blinka +adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..7c5e69b --- /dev/null +++ b/setup.py @@ -0,0 +1,64 @@ +"""A setuptools based setup module. + +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +from setuptools import setup, find_packages +# To use a consistent encoding +from codecs import open +from os import path + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, 'README.rst'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='adafruit-circuitpython-turtle', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='Turtle graphics library for CircuitPython and displayio', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_turtle', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=[ + 'Adafruit-Blinka', + 'adafruit-circuitpython-busdevice' + ], + + # Choose your license + license='MIT', + + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Topic :: Software Development :: Libraries', + 'Topic :: System :: Hardware', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + ], + + # What does your project relate to? + keywords='adafruit blinka circuitpython micropython turtle graphics,turtle', + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, + # CHANGE `py_modules=['...']` TO `packages=['...']` + py_modules=['adafruit_turtle'], +) From 12139d25a14027774994ca08f8ebeda7b16ccfba Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 12:06:29 -0400 Subject: [PATCH 05/18] Replace with README.rst --- README.md | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 2d3dcce..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Adafruit_CircuitPython_turtle -left! right! forward! turtle power! From e01dd86251408736ef9185da353f06c49e86530c Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 12:38:24 -0400 Subject: [PATCH 06/18] Pylint tweaks --- adafruit_turtle.py | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/adafruit_turtle.py b/adafruit_turtle.py index 55d9d1f..921cbd0 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -38,9 +38,6 @@ **Hardware:** -.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered list & hyperlink rST - inline format: "* `Link Text `_" - **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: @@ -49,6 +46,8 @@ * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ +#pylint:disable=too-many-public-methods,invalid-name,too-many-instance-attributes,too-few-public-methods + import displayio import board import gc @@ -62,10 +61,10 @@ class Color: WHITE = 0xFFFFFF BLACK = 0x0000 - RED = 0xFF0000 + RED = 0xFF0000 ORANGE = 0xFFA500 YELLOW = 0xFFFF00 - GREEN = 0x00FF00 + GREEN = 0x00FF00 BLUE = 0x0000FF PURPLE = 0x800080 PINK = 0xFFC0CB @@ -144,8 +143,8 @@ def __init__(self, display=board.DISPLAY): self._bg_palette = displayio.Palette(1) self._bg_palette[0] = Color.BLACK self._bg_sprite = displayio.TileGrid(self._bg_bitmap, - pixel_shader=self._bg_palette, - x=0, y=0) + pixel_shader=self._bg_palette, + x=0, y=0) self._splash.append(self._bg_sprite) self._fg_bitmap = displayio.Bitmap(self._w, self._h, 5) @@ -154,8 +153,8 @@ def __init__(self, display=board.DISPLAY): for i,c in enumerate(Color.colors): self._fg_palette[i + 1] = c self._fg_sprite = displayio.TileGrid(self._fg_bitmap, - pixel_shader=self._fg_palette, - x=0, y=0) + pixel_shader=self._fg_palette, + x=0, y=0) self._splash.append(self._fg_sprite) self._turtle_bitmap = displayio.Bitmap(9, 9, 2) @@ -168,8 +167,8 @@ def __init__(self, display=board.DISPLAY): self._turtle_bitmap[4 + i, 7 - i] = 1 self._turtle_bitmap[4 + i, i] = 1 self._turtle_sprite = displayio.TileGrid(self._turtle_bitmap, - pixel_shader=self._turtle_palette, - x=-100, y=-100) + pixel_shader=self._turtle_palette, + x=-100, y=-100) self._drawturtle() self._splash.append(self._turtle_sprite) @@ -344,7 +343,7 @@ def isdown(self): def pencolor(self, c): if not c in Color.colors: - raise RuntimeError("Color must be one of the 'color' class items") + raise RuntimeError("Color must be one of the 'Color' class items") self._pencolor = 1 + Color.colors.index(c) def mode(self, mode=None): @@ -355,10 +354,10 @@ def mode(self, mode=None): elif mode is None: if self._logomode: return "logo" - else: - return "standard" + return "standard" else: raise RuntimeError("Mode must be 'logo' or 'standard!'") + return "" def _turn(self, angle): if self._logomode: From 0e35ad5b55b12895f2ad4330911ac8972ecfa179 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 12:56:22 -0400 Subject: [PATCH 07/18] pylint tweaks --- adafruit_turtle.py | 6 ++++-- examples/turtle_benzene.py | 2 +- examples/turtle_simpletest.py | 2 +- examples/turtle_square.py | 2 +- examples/turtle_star.py | 2 +- 5 files changed, 8 insertions(+), 6 deletions(-) diff --git a/adafruit_turtle.py b/adafruit_turtle.py index 921cbd0..d11eb6f 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -48,11 +48,11 @@ #pylint:disable=too-many-public-methods,invalid-name,too-many-instance-attributes,too-few-public-methods -import displayio -import board import gc import math import time +import displayio +import board import adafruit_logging as logging __version__ = "0.0.0-auto.0" @@ -207,6 +207,7 @@ def left(self, angle): self._turn(-angle) lt = left + #pylint:disable=too-many-branches,too-many-statements def goto(self, x1, y1=None): if y1 is None: y1 = x1[1] @@ -287,6 +288,7 @@ def home(self): def circle(self, radius, extent=None, steps=None): raise NotImplementedError +#pylint:disable=keyword-arg-before-vararg def dot(self, size=None, *color): raise NotImplementedError diff --git a/examples/turtle_benzene.py b/examples/turtle_benzene.py index cf09bf9..cd8fcf9 100644 --- a/examples/turtle_benzene.py +++ b/examples/turtle_benzene.py @@ -1,5 +1,5 @@ import board -from adafruit_turtle import * +from adafruit_turtle import Color, turtle turtle = turtle(board.DISPLAY) benzsize = min(board.DISPLAY.width, board.DISPLAY.height) * 0.5 diff --git a/examples/turtle_simpletest.py b/examples/turtle_simpletest.py index 39fe33c..2b8587c 100644 --- a/examples/turtle_simpletest.py +++ b/examples/turtle_simpletest.py @@ -1,5 +1,5 @@ import board -from adafruit_turtle import * +from adafruit_turtle import Color, turtle turtle = turtle(board.DISPLAY) starsize = min(board.DISPLAY.width, board.DISPLAY.height) * 0.9 # 90% of screensize diff --git a/examples/turtle_square.py b/examples/turtle_square.py index adf7c95..3edc8f6 100644 --- a/examples/turtle_square.py +++ b/examples/turtle_square.py @@ -1,5 +1,5 @@ import board -from adafruit_turtle import * +from adafruit_turtle import Color, turtle turtle = turtle(board.DISPLAY) print("Turtle time! Lets draw a simple square") diff --git a/examples/turtle_star.py b/examples/turtle_star.py index 39fe33c..2b8587c 100644 --- a/examples/turtle_star.py +++ b/examples/turtle_star.py @@ -1,5 +1,5 @@ import board -from adafruit_turtle import * +from adafruit_turtle import Color, turtle turtle = turtle(board.DISPLAY) starsize = min(board.DISPLAY.width, board.DISPLAY.height) * 0.9 # 90% of screensize From 0710a197f537d417e08274bd6920778158344ae3 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 14:23:07 -0400 Subject: [PATCH 08/18] Pylint tweaks: mostly adding doc strings --- adafruit_turtle.py | 180 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 173 insertions(+), 7 deletions(-) diff --git a/adafruit_turtle.py b/adafruit_turtle.py index d11eb6f..caa755a 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -51,8 +51,8 @@ import gc import math import time -import displayio import board +import displayio import adafruit_logging as logging __version__ = "0.0.0-auto.0" @@ -60,7 +60,7 @@ class Color: WHITE = 0xFFFFFF - BLACK = 0x0000 + BLACK = 0x000000 RED = 0xFF0000 ORANGE = 0xFFA500 YELLOW = 0xFFFF00 @@ -109,7 +109,10 @@ def __abs__(self): return (self[0]**2 + self[1]**2)**0.5 def rotate(self, angle): - """rotate self counterclockwise by angle + """Rotate self counterclockwise by angle. + + :param angle: how much to rotate + """ perp = Vec2D(-self[1], self[0]) angle = angle * math.pi / 180.0 @@ -188,6 +191,10 @@ def _drawturtle(self): # Turtle motion def forward(self, distance): + """Move the turtle forward by the specified distance, in the direction the turtle is headed. + + :param distance: how far to move (integer or float) + """ p = self.pos() x1 = p[0] + math.sin(math.radians(self._heading)) * distance y1 = p[1] + math.cos(math.radians(self._heading)) * distance @@ -195,20 +202,57 @@ def forward(self, distance): fd = forward def backward(self, distance): + """Move the turtle backward by distance, opposite to the direction the turtle is headed. + Does not change the turtle’s heading. + + :param distance: how far to move (integer or float) + """ + self.forward(-distance) bk = backward back = backward + def degrees(self, fullcircle=360): + """Set angle measurement units, i.e. set number of “degrees” for a full circle. + Default value is 360 degrees. + + :param fullcircle: the number of degrees in a full circle + """ + raise NotImplementedError + + def radians(self): + """Set the angle measurement units to radians. Equivalent to degrees(2*math.pi).""" + raise NotImplementedError + def right(self, angle): + """Turn turtle right by angle units. (Units are by default degrees, + but can be set via the degrees() and radians() functions.) + Angle orientation depends on the turtle mode, see mode(). + + :param angle: how much to rotate to the right (integer or float) + """ self._turn(angle) rt = right def left(self, angle): + """Turn turtle left by angle units. (Units are by default degrees, + but can be set via the degrees() and radians() functions.) + Angle orientation depends on the turtle mode, see mode(). + + :param angle: how much to rotate to the left (integer or float) + """ self._turn(-angle) lt = left #pylint:disable=too-many-branches,too-many-statements def goto(self, x1, y1=None): + """If y1 is None, x1 must be a pair of coordinates or an (x, y) tuple + + Move turtle to an absolute position. If the pen is down, draw line. Do not change the turtle’s orientation. + + :param x1: a number or a pair of numbers + :param y1: a number or None + """ if y1 is None: y1 = x1[1] x1 = x1[0] @@ -272,49 +316,149 @@ def goto(self, x1, y1=None): setposition = goto def setx(self, x): + """Set the turtle’s first coordinate to x, leave second coordinate + unchanged. + + :param x: new value of the turtle's x coordinate (a number) + + """ self.goto(x, self.pos()[1]) def sety(self, y): + """Set the turtle’s second coordinate to y, leave first coordinate + unchanged. + + :param y: new value of the turtle's y coordinate (a number) + + """ self.goto(self.pos()[0], y) def setheading(self, to_angle): + """Set the orientation of the turtle to to_angle. Here are some common + directions in degrees: + + standard mode | logo mode + --------------+---------- + 0 - east | 0 - north + 90 - north | 90 - east + 180 - west | 180 - south + 270 - south | 270 - west + + :param to_angle: the new turtle heading + + """ + self._heading = to_angle seth = setheading def home(self): + """Move turtle to the origin – coordinates (0,0) – and set its heading to + its start-orientation + (which depends on the mode, see mode()). + """ self.setheading(90) self.goto(0,0) def circle(self, radius, extent=None, steps=None): + """Draw a circle with given radius. The center is radius units left of + the turtle; extent – an angle – determines which part of the circle is + drawn. If extent is not given, draw the entire circle. If extent is not + a full circle, one endpoint of the arc is the current pen position. + Draw the arc in counterclockwise direction if radius is positive, + otherwise in clockwise direction. Finally the direction of the turtle + is changed by the amount of extent. + + As the circle is approximated by an inscribed regular polygon, steps + determines the number of steps to use. If not given, it will be + calculated automatically. May be used to draw regular polygons. + + :param radius: the radius of the circle + :param extent: the arc of the circle to be drawn + :param steps: how many points along the arc are computed + + """ raise NotImplementedError #pylint:disable=keyword-arg-before-vararg def dot(self, size=None, *color): + """Draw a circular dot with diameter size, using color. + If size is not given, the maximum of pensize+4 and + 2*pensize is used. + + :param size: the diameter of the dot + :param color: the color of the dot + + """ raise NotImplementedError def stamp(self): + """Stamp a copy of the turtle shape onto the canvas at the current + turtle position. Return a stamp_id for that stamp, which can be used to + delete it by calling clearstamp(stamp_id). + """ raise NotImplementedError - def clearstamp(self): + def clearstamp(self, stampid): + """Delete stamp with given stampid. + + :param stampid: the id of the stamp to be deleted + + """ raise NotImplementedError - def clearstamps(self): + def clearstamps(self, n=None): + """Delete all or first/last n of turtle’s stamps. If n is None, delete + all stamps, if n > 0 delete first n stamps, else if n < 0 delete last + n stamps. + + :param n: how many stamps to delete (None means delete them all) + + """ raise NotImplementedError def undo(self): + """Undo (repeatedly) the last turtle action(s). Number of available undo + actions is determined by the size of the undobuffer. + """ raise NotImplementedError def speed(self, speed=None): + """Set the turtle’s speed to an integer value in the range 0..10. If no + argument is given, return current speed. + + If input is a number greater than 10 or smaller than 0.5, speed is set + to 0. Speedstrings are mapped to speedvalues as follows: + + “fastest”: 0 + “fast”: 10 + “normal”: 6 + “slow”: 3 + “slowest”: 1 + + Speeds from 1 to 10 enforce increasingly faster animation of line + drawing and turtle turning. + + Attention: speed = 0 means that no animation takes place. + forward/back makes turtle jump and likewise left/right make the + turtle turn instantly. + + :param speed: the new turtle speed (0..10) or None + """ raise NotImplementedError #################### # Tell turtle's state def pos(self): + """Return the turtle’s current location (x,y) (as a Vec2D vector).""" return Vec2D(self._x - self._w // 2, self._h // 2 - self._y) position=pos def clear(self): + """Delete the turtle’s drawings from the screen. Do not move turtle. + State and position of the turtle as well as drawings of other turtles + are not affected. + """ for w in range(self._w): for h in range(self._h): self._fg_bitmap[w, h] = 0 @@ -327,28 +471,50 @@ def clear(self): time.sleep(0.1) def heading(self): + """Return the turtle’s current heading (value depends on the turtle mode, see mode()).""" return self._heading # Pen control def pendown(self): + """Pull the pen down – drawing when moving.""" self._penstate = True pd = pendown down = pendown def penup(self): + """Pull the pen up – no drawing when moving.""" self._penstate = False pu = penup up = penup def isdown(self): + """Return True if pen is down, False if it’s up.""" return self._penstate - def pencolor(self, c): + def pencolor(self, c=None): + """ + Return or set the pencolor. + + :param c: the color to which to set the pen, + None will cause the color to be returned + """ + if c is None: + return Color.colors[self._pencolor - 1] if not c in Color.colors: raise RuntimeError("Color must be one of the 'Color' class items") self._pencolor = 1 + Color.colors.index(c) + return c def mode(self, mode=None): + """ + Set turtle mode (“standard”, “logo” or “world”) and perform reset. + If mode is not given, current mode is returned. + + Mode “standard” is compatible with old turtle. + Mode “logo” is compatible with most Logo turtle graphics. + + :param mode: one of the strings “standard” or “logo" + """ if mode == "standard": self._logomode = False elif mode == "logo": @@ -359,7 +525,7 @@ def mode(self, mode=None): return "standard" else: raise RuntimeError("Mode must be 'logo' or 'standard!'") - return "" + return None def _turn(self, angle): if self._logomode: From 7b14c81f98816e99eea503fc33472773435ca5b6 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 14:44:30 -0400 Subject: [PATCH 09/18] pylint tweaks --- adafruit_turtle.py | 16 ++++++++++------ docs/conf.py | 2 +- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/adafruit_turtle.py b/adafruit_turtle.py index caa755a..10ec092 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -59,6 +59,7 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_turtle.git" class Color: + """Standard colors""" WHITE = 0xFFFFFF BLACK = 0x000000 RED = 0xFF0000 @@ -84,7 +85,7 @@ class Vec2D(tuple): |a| absolute value of a a.rotate(angle) rotation """ - def __init__(cls, x, y): + def __init__(self, x, y): super().__init__((x, y)) def __add__(self, other): @@ -96,8 +97,9 @@ def __mul__(self, other): return Vec2D(self[0] * other, self[1] * other) def __rmul__(self, other): - if isinstance(other, int) or isinstance(other, float): + if isinstance(other, (float, int)): return Vec2D(self[0] * other, self[1] * other) + return None def __sub__(self, other): return Vec2D(self[0] - other[0], self[1] - other[1]) @@ -127,6 +129,7 @@ def __repr__(self): class turtle: + """A Turtle that can be given commands to draw.""" def __init__(self, display=board.DISPLAY): self._logger = logging.getLogger("Turtle") @@ -153,7 +156,7 @@ def __init__(self, display=board.DISPLAY): self._fg_bitmap = displayio.Bitmap(self._w, self._h, 5) self._fg_palette = displayio.Palette(len(Color.colors) + 1) self._fg_palette.make_transparent(0) - for i,c in enumerate(Color.colors): + for i, c in enumerate(Color.colors): self._fg_palette[i + 1] = c self._fg_sprite = displayio.TileGrid(self._fg_bitmap, pixel_shader=self._fg_palette, @@ -248,7 +251,8 @@ def left(self, angle): def goto(self, x1, y1=None): """If y1 is None, x1 must be a pair of coordinates or an (x, y) tuple - Move turtle to an absolute position. If the pen is down, draw line. Do not change the turtle’s orientation. + Move turtle to an absolute position. If the pen is down, draw line. + Does not change the turtle’s orientation. :param x1: a number or a pair of numbers :param y1: a number or None @@ -357,7 +361,7 @@ def home(self): (which depends on the mode, see mode()). """ self.setheading(90) - self.goto(0,0) + self.goto(0, 0) def circle(self, radius, extent=None, steps=None): """Draw a circle with given radius. The center is radius units left of @@ -452,7 +456,7 @@ def speed(self, speed=None): def pos(self): """Return the turtle’s current location (x,y) (as a Vec2D vector).""" return Vec2D(self._x - self._w // 2, self._h // 2 - self._y) - position=pos + position = pos def clear(self): """Delete the turtle’s drawings from the screen. Do not move turtle. diff --git a/docs/conf.py b/docs/conf.py index 6644f28..d3c5a02 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -# autodoc_mock_imports = ["digitalio", "busio"] +autodoc_mock_imports = ["displayio"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} From 0389a27a5f8e52352f5e5b508b22a539c6c7e1c0 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 15:05:51 -0400 Subject: [PATCH 10/18] pylint tweaks --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index d3c5a02..0637fe8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -autodoc_mock_imports = ["displayio"] +autodoc_mock_imports = ["displayio", "adafruit_logging"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} From 88d0ca33e82fa6157bb97d92109342c0b9f3f091 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 15:21:02 -0400 Subject: [PATCH 11/18] Tweaks --- docs/conf.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 0637fe8..c049df3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,10 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -autodoc_mock_imports = ["displayio", "adafruit_logging"] +autodoc_mock_imports = ["rtc", "supervisor", "pulseio", "audioio", "displayio", "neopixel", + "microcontroller", "adafruit_touchscreen", "adafruit_bitmap_font", + "adafruit_display_text", "adafruit_esp32spi", "secrets", + "adafruit_sdcard", "storage", "adafruit_io", "adafruit_button"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} @@ -35,8 +38,8 @@ # General information about the project. project = u'Adafruit turtle Library' -copyright = u'2019 LadyAda and Dave Astels' -author = u'LadyAda and Dave Astels' +copyright = u'2019 Adafruit' +author = u'Adafruit' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the From 39fe79451daacaaad69cf045066c717a436e4396 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 15:34:41 -0400 Subject: [PATCH 12/18] sphinx tweaks --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index c049df3..b2d105f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,8 @@ autodoc_mock_imports = ["rtc", "supervisor", "pulseio", "audioio", "displayio", "neopixel", "microcontroller", "adafruit_touchscreen", "adafruit_bitmap_font", "adafruit_display_text", "adafruit_esp32spi", "secrets", - "adafruit_sdcard", "storage", "adafruit_io", "adafruit_button"] + "adafruit_sdcard", "storage", "adafruit_io", "adafruit_button", + "adafruit_logging"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} From 40e412d5c116a39b2f32ff1f93a77b2da994fe17 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 20:20:18 -0400 Subject: [PATCH 13/18] Build tweaks --- docs/conf.py | 2 +- requirements.txt | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index b2d105f..3e310bd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,7 +24,7 @@ "microcontroller", "adafruit_touchscreen", "adafruit_bitmap_font", "adafruit_display_text", "adafruit_esp32spi", "secrets", "adafruit_sdcard", "storage", "adafruit_io", "adafruit_button", - "adafruit_logging"] + "adafruit_logging", "board"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} diff --git a/requirements.txt b/requirements.txt index 3031961..edf9394 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1 @@ Adafruit-Blinka -adafruit-circuitpython-busdevice From f2f89ffe569de088f83099b5929de4057c7b83ef Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 20:29:05 -0400 Subject: [PATCH 14/18] Try to deal with complaints about indentation IN A COMMENT! --- adafruit_turtle.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/adafruit_turtle.py b/adafruit_turtle.py index 10ec092..88fa53c 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -77,13 +77,14 @@ class Vec2D(tuple): for implementing turtle graphics. May be useful for turtle graphics programs also. Derived from tuple, so a vector is a tuple! + Provides (for a, b vectors, k number): - a+b vector addition - a-b vector subtraction - a*b inner product - k*a and a*k multiplication with scalar - |a| absolute value of a - a.rotate(angle) rotation + a+b vector addition + a-b vector subtraction + a*b inner product + k*a and a*k multiplication with scalar + |a| absolute value of a + a.rotate(angle) rotation """ def __init__(self, x, y): super().__init__((x, y)) From 6f34ce756f894df55571088e1eec48b402891b7b Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 20:40:41 -0400 Subject: [PATCH 15/18] More doc string formatting --- adafruit_turtle.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/adafruit_turtle.py b/adafruit_turtle.py index 88fa53c..1b82c11 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -343,11 +343,10 @@ def setheading(self, to_angle): directions in degrees: standard mode | logo mode - --------------+---------- - 0 - east | 0 - north - 90 - north | 90 - east - 180 - west | 180 - south - 270 - south | 270 - west + 0 - east | 0 - north + 90 - north | 90 - east + 180 - west | 180 - south + 270 - south | 270 - west :param to_angle: the new turtle heading From 027028193b46382a4202696bc99c315f718a11a0 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 21:12:25 -0400 Subject: [PATCH 16/18] More sphnix comment formatting --- adafruit_turtle.py | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/adafruit_turtle.py b/adafruit_turtle.py index 1b82c11..03ca124 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -77,15 +77,14 @@ class Vec2D(tuple): for implementing turtle graphics. May be useful for turtle graphics programs also. Derived from tuple, so a vector is a tuple! - - Provides (for a, b vectors, k number): - a+b vector addition - a-b vector subtraction - a*b inner product - k*a and a*k multiplication with scalar - |a| absolute value of a - a.rotate(angle) rotation """ + # Provides (for a, b vectors, k number): + # a+b vector addition + # a-b vector subtraction + # a*b inner product + # k*a and a*k multiplication with scalar + # |a| absolute value of a + # a.rotate(angle) rotation def __init__(self, x, y): super().__init__((x, y)) From d14dc6cd4ca430ff2ed02b9e8168f75a1c8b08ae Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 21:20:33 -0400 Subject: [PATCH 17/18] Clean up todos --- README.rst | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 2a60f49..3c615b6 100644 --- a/README.rst +++ b/README.rst @@ -29,11 +29,6 @@ This is easily achieved by downloading Installing from PyPI ===================== -.. note:: This library is not available on PyPI yet. Install documentation is included - as a standard element. Stay tuned for PyPI availability! - -.. todo:: Remove the above note if PyPI version is/will be available at time of release. - If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section. On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI `_. To install for current user: @@ -60,7 +55,31 @@ To install in a virtual environment in your current project: Usage Example ============= -.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. +.. code-block:: python + + import board + from adafruit_turtle import Color, turtle + + turtle = turtle(board.DISPLAY) + starsize = min(board.DISPLAY.width, board.DISPLAY.height) * 0.9 # 90% of screensize + + print("Turtle time! Lets draw a star") + + turtle.pencolor(Color.BLUE) + + turtle.penup() + turtle.goto(-starsize/2, 0) + turtle.pendown() + + start = turtle.pos() + while True: + turtle.forward(starsize) + turtle.left(170) + if abs(turtle.pos() - start) < 1: + break + + while True: + pass Contributing ============ From 9902103572d57aa751dcfc8d95ac2a2643a604e4 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Mon, 24 Jun 2019 21:23:21 -0400 Subject: [PATCH 18/18] Clean up todos --- docs/index.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 14601ae..722c2a1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,15 +23,9 @@ Table of Contents .. toctree:: :caption: Tutorials -.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave - the toctree above for use later. - .. toctree:: :caption: Related Products -.. todo:: Add any product links here. If there are none, then simply delete this todo and leave - the toctree above for use later. - .. toctree:: :caption: Other Links