Skip to main content

Yet another Python brainfuck interpreter

Project description

pybrainfuck
===========

.. image:: https://img.shields.io/pypi/v/pybrainfuck.svg
:alt: PyPi Version
:scale: 100%
:target: https://pypi.python.org/pypi/pybrainfuck/

.. image:: https://img.shields.io/pypi/dm/pybrainfuck.svg
:alt: PyPi Monthly Donwloads
:scale: 100%
:target: https://pypi.python.org/pypi/pybrainfuck/

.. image:: https://img.shields.io/pypi/l/pybrainfuck.svg
:alt: License
:scale: 100%
:target: https://github.com/mementum/pybrainfuck/blob/master/LICENSE

.. image:: https://travis-ci.org/mementum/pybrainfuck.png?branch=master
:alt: Travis-ci Build Status
:scale: 100%
:target: https://travis-ci.org/mementum/pybrainfuck

.. image:: https://readthedocs.org/projects/pybrainfuck/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://readthedocs.org/projects/pybrainfuck/

.. image:: https://img.shields.io/pypi/pyversions/pybrainfuck.svg
:alt: Pytghon versions
:scale: 100%
:target: https://pypi.python.org/pypi/pybrainfuck/

``pybrainfuck`` is yet another Python BrainFuck implementation. The goal is not
be the fastest or most efficient but rather to be extensive in the
implementation, configurable and extendable.

It contains a ``BrainFck`` class which can be directly used or subclassed to
use in scripts. The code is fully documented and commented.

Or else the pip installed script ``pybrainfuck`` can be directly used.

Documentation
=============

Read the full documentation at readthedocs.org:

- `pybrainfuck documentation <http://pybrainfuck.readthedocs.org/en/latest/introduction.html>`_


Python 2/3 Support
==================

- Python 2.7
- Python 3.2/3.3/3.4/3.5

- It also works with pypy and pypy3


Installation
============

From pypi::

pip install pybrainfuck

From source:

- Place the *pybrainfuck* directory found in the sources inside your project
and import it

Scriptwise:

- The entire implementation has been kept inside a single file. You can copy
it inside other sources too


Quick Usage
===========

Let's quickly put together a script::

from __future__ import (absolute_import, division, print_function,
unicode_literals)

import sys

from pybrainfuck import BrainFck

if name == '__main__':

bfck = BrainFck()

for arg in sys.argv[1:]:
print('-' * 50)
print('Running:', arg)
print('-' * 50)
bfck.runfile(arg)
print()

And prepare a **Hello World** (including a newline) ``brainfuck`` program::

++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.

And both paired for a execution::

$ ./readme-example.py readme-example.b
--------------------------------------------------
Running: readme-example.b
--------------------------------------------------
Hello World!


Although the newlines after ``Hello World!`` are difficult to perceive.

Using the built-in script ``pybrainfuck``::

$ pybrainfuck readme-example.b
Hello World!

Which luckily produces the same result.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

pybrainfuck-1.0.1-py2.py3-none-any.whl (13.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pybrainfuck-1.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pybrainfuck-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 698bc4de98b29b753a7f09841c3a8e3e972c24cb1f5f823915df0d1501bd9f5f
MD5 b4883abd073ca986d84ba60bad22e56b
BLAKE2b-256 5eb2dc24e40ebeb83b49f05c885d581d4efa5853db5f0b6dd789f9137f169302

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page