Skip to content
Permalink
Browse files

Work done so far - project template. Incomplete and missing tests.

  • Loading branch information
ntoll committed Jul 26, 2019
1 parent f58280a commit 9cff63316374a5f81460aeb0f81ade92e26ed7fd
@@ -0,0 +1,3 @@
# Authors of PyperCard

Nicholas H.Tollervey (ntoll@ntoll.org)
@@ -0,0 +1,15 @@
# Release History

## 0.0.1-alpha.1

Initial release.

* CardApp and Card core classes implemented.
* Input enumeration defines available input form widgets.
* The palette function takes either English or HEX (preceeded by "0x" or "#")
values and returns a Kivy representation of the referenced colour.
* Command line utility to create and manage GUI projects.
* 100% unit test coverage.
* Documentation.
* Example projects.
* Core `Makefile` functionality.
@@ -0,0 +1,43 @@
# Code of Conduct

We expect contributors to follow the
[Python Software Foundation's Code of Conduct](https://www.python.org/psf/codeofconduct/),
reproduced below.

The Python community is made up of members from around the globe with a diverse
set of skills, personalities, and experiences. It is through these differences
that our community experiences great successes and continued growth. When
you're working with members of the community, we encourage you to follow these
guidelines which help steer our interactions and strive to keep Python a
positive, successful, and growing community.

A member of the Python community is:

## Open

Members of the community are open to collaboration, whether it's on PEPs,
patches, problems, or otherwise. We're receptive to constructive comment and
criticism, as the experiences and skill sets of other members contribute to the
whole of our efforts. We're accepting of all who wish to take part in our
activities, fostering an environment where anyone can participate and everyone
can make a difference.

## Considerate

Members of the community are considerate of their peers -- other Python users.
We're thoughtful when addressing the efforts of others, keeping in mind that
often times the labor was completed simply for the good of the community. We're
attentive in our communications, whether in person or online, and we're tactful
when approaching differing views.

## Respectful

Members of the community are respectful. We're respectful of others, their
positions, their skills, their commitments, and their efforts. We're respectful
of the volunteer efforts that permeate the Python community. We're respectful
of the processes set forth in the community, and we work within them. When we
disagree, we are courteous in raising our issues.

Overall, we're good to each other. We contribute to this community not because
we have to, but because we want to. If we remember that, these guidelines will
come naturally.
21 LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 Nicholas Tollervey

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.
@@ -0,0 +1,13 @@
# PyperCard - A Pythonic HyperCard for Beginner Programmers

A re-implementation of
[Adafruit's CircuitPython PYOA](https://github.com/adafruit/Adafruit_CircuitPython_PYOA)
module for non-CircuitPython computing environments. This module re-uses the
JSON specification used to create HyperCard like "stacks" of states between
which users transition in a choose-your-own-adventure style.

This is very much a first draft bodge. ;-)

## Developer Setup


@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -0,0 +1,55 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'PyperCard'
copyright = '2019, Nicholas H.Tollervey'
author = 'Nicholas H.Tollervey'

# The full version, including alpha/beta/rc tags
release = '0.0.1'


# -- 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 = [
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

# 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']
@@ -0,0 +1,20 @@
.. PyperCard documentation master file, created by
sphinx-quickstart on Fri Jul 26 17:59:56 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to PyperCard's documentation!
=====================================

.. toctree::
:maxdepth: 2
:caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
No changes.
Binary file not shown.
@@ -0,0 +1,17 @@
from .core import Card, CardApp, Inputs, palette

__all__ = ["Card", "CardApp", "Inputs", "palette", ]

# IMPORTANT
# ---------
# Keep these metadata assignments simple and single-line. They are parsed
# somewhat naively by setup.py and the Windows installer generation script.

__title__ = 'pypercard'
__description__ = 'A HyperCard inspired GUI framework for beginner developers.'
__version__ = '0.0.1-alpha.1'
__license__ = 'MIT'
__url__ = 'https://github.com/ntoll/pypercard'
__author__ = 'Nicholas H.Tollervey'
__email__ = 'ntoll@ntoll.org'

0 comments on commit 9cff633

Please sign in to comment.
You can’t perform that action at this time.