Skip to content

Latest commit

 

History

History
89 lines (66 loc) · 2.94 KB

README.md

File metadata and controls

89 lines (66 loc) · 2.94 KB
Raw

Invent - an app framework for beginners

View this repository via GitHub pages.

This project's documentation can be found here.

This project started in 2019 as "PyperCard" ~ a re-implementation of Adafruit's CircuitPython PYOA module, but for non-CircuitPython computing environments. It was originally written using the Kivy framework for cross-platform development. After successfully testing PyperCard for teaching and learning purposes with the wonderful young folk at the London Young Coders' Meetup, development stalled because of the COVID pandemic.

The project name has since been changed to "Invent" to remove any HyperCard related expectations. There are further significant changes:

  • PyScript replaces Kivy as the underlying cross-platform framework for generating and running the user interface.
  • Nicholas, the original developer and maintainer of Invent/PyperCard, has been hired by Anaconda Inc to work on PyScript, and so his work on this project is sponsored by his employer.
  • Ownership of the repository has been transferred to the invent framework organisation on GitHub (the old repository will automatically redirect to the new one).
  • Since this is a complete rewrite, the license has been changed from MIT to Apache2.

All the assets relating to the old version of the project can still be found in the old branch in this repository.

Developer setup

Git clone the repository:

git clone https://github.com/invent-framework/invent.git

(Recommended) Upgrade local pip:

pip install --upgrade pip

Make a virtualenv, then install the requirements:

pip install -r requirements.txt

Most useful developer related tasks are automated by a Makefile:

$ make
There's no default Makefile target right now. Try:

make clean - reset the project and remove auto-generated assets.
make tidy - tidy up the code with the 'black' formatter.
make lint - check the code for obvious errors with flake8.
make lint-all - check all code for obvious errors with flake8.
make serve - serve the project at: http://0.0.0.0:8000/
make test - while serving the app, run the test suite in browser.
make dist - build the module as a package.
make publish-test - upload the package to the PyPI test instance.
make publish-live - upload the package to the PyPI LIVE instance.

To run the test suite:

$ make serve

Then visit http://localhost:8000/.

The tests should open in your browser, and pass. ;-)

Please use a width of 79 characters for source code files.

Example applications

Coming soon...