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.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! diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..3c615b6 --- /dev/null +++ b/README.rst @@ -0,0 +1,139 @@ +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 +===================== + +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 +============= + +.. 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 +============ + +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 e194bc7..03ca124 100644 --- a/adafruit_turtle.py +++ b/adafruit_turtle.py @@ -3,37 +3,69 @@ # 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 -import displayio -import board +* Author(s): LadyAda and Dave Astels + +Implementation Notes +-------------------- + +**Hardware:** + +**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 +""" + +#pylint:disable=too-many-public-methods,invalid-name,too-many-instance-attributes,too-few-public-methods + import gc import math import time +import board +import displayio +import adafruit_logging as logging + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_turtle.git" class Color: + """Standard colors""" WHITE = 0xFFFFFF - BLACK = 0x0000 - RED = 0xFF0000 + BLACK = 0x000000 + RED = 0xFF0000 ORANGE = 0xFFA500 YELLOW = 0xFFFF00 - GREEN = 0x00FF00 + GREEN = 0x00FF00 BLUE = 0x0000FF PURPLE = 0x800080 PINK = 0xFFC0CB @@ -45,52 +77,68 @@ 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 """ - def __init__(cls, x, y): + # 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)) + 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) + 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]) + 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 + """Rotate self counterclockwise by angle. + + :param angle: how much to rotate + """ 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 class turtle: + """A Turtle that can be given commands to draw.""" 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 - 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 @@ -101,18 +149,18 @@ 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) - 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 + 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) @@ -120,13 +168,13 @@ 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) + pixel_shader=self._turtle_palette, + x=-100, y=-100) self._drawturtle() self._splash.append(self._turtle_sprite) @@ -142,38 +190,81 @@ 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): + """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 + 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 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. + Does 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] - x1 += self._w//2 - y1 = self._h//2 - y1 + x1 += self._w // 2 + 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 @@ -229,86 +320,204 @@ 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) + 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 Vec2D(self._x - self._w//2, self._h//2 - self._y) - position=pos + """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 - 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 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") + 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. - def mode(self, mode=None): + :param mode: one of the strings “standard” or “logo" + """ if mode == "standard": self._logomode = False elif mode == "logo": @@ -316,10 +525,11 @@ 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 None + def _turn(self, angle): if self._logomode: self._heading -= angle diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000..5aca983 Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..db048c0 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,8 @@ + +.. If you created a package, create one automodule per module in the package. + +.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) +.. use this format as the module name: "adafruit_foo.foo" + +.. automodule:: adafruit_turtle + :members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3e310bd --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,164 @@ +# -*- coding: utf-8 -*- + +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + +# -- General configuration ------------------------------------------------ + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + 'sphinx.ext.todo', +] + +# TODO: Please Read! +# 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 = ["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_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)} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Adafruit turtle Library' +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 +# built documents. +# +# The short X.Y version. +version = u'1.0' +# The full version, including alpha/beta/rc tags. +release = u'1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +default_role = "any" + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +add_function_parentheses = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# If this is True, todo emits a warning for each TODO entries. The default is False. +todo_emit_warnings = True + +napoleon_numpy_docstring = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + try: + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.'] + except: + html_theme = 'default' + html_theme_path = ['.'] +else: + html_theme_path = ['.'] + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +html_favicon = '_static/favicon.ico' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'AdafruitTurtleLibrarydoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'AdafruitturtleLibrary.tex', u'Adafruitturtle Library Documentation', + author, 'manual'), +] + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'Adafruitturtlelibrary', u'Adafruit turtle Library Documentation', + [author], 1) +] + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'AdafruitturtleLibrary', u'Adafruit turtle Library Documentation', + author, 'AdafruitturtleLibrary', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..d04fe80 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,8 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/turtle_simpletest.py + :caption: examples/turtle_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..722c2a1 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,45 @@ +.. include:: ../README.rst + +Table of Contents +================= + +.. toctree:: + :maxdepth: 4 + :hidden: + + self + +.. toctree:: + :caption: Examples + + examples + +.. toctree:: + :caption: API Reference + :maxdepth: 3 + + api + +.. toctree:: + :caption: Tutorials + +.. toctree:: + :caption: Related Products + +.. toctree:: + :caption: Other Links + + Download + 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_benzene.py b/examples/turtle_benzene.py index e1ce8c4..cd8fcf9 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 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 new file mode 100644 index 0000000..2b8587c --- /dev/null +++ b/examples/turtle_simpletest.py @@ -0,0 +1,23 @@ +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 diff --git a/examples/turtle_square.py b/examples/turtle_square.py index 4ba876a..3edc8f6 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 Color, turtle 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..2b8587c 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 Color, turtle turtle = turtle(board.DISPLAY) starsize = min(board.DISPLAY.width, board.DISPLAY.height) * 0.9 # 90% of screensize diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..edf9394 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +Adafruit-Blinka 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'], +)