Brainfk
=======
Brainfk is a Python package that provides an interpreter for the Brainfuck programming language. It allows you to execute Brainfuck code and see the output.
Features
--------
- Simple and intuitive interface to run Brainfuck code.
- Supports reading Brainfuck code from a file or direct input.
- Handles the basic Brainfuck commands: +, -, <, >, ., ,, [, ].
- Supports nested loops in Brainfuck code.
Installation
------------
You can install Brainfk using pip:
```
pip install brainfk
```
Brainfk requires Python 3.7 or higher.
Usage
-----
You can run the Brainfuck interpreter by executing the `brainfk` command followed by the path to a file containing Brainfuck code or by providing the code directly as input.
To execute Brainfuck code from a file:
```
brainfk path/to/brainfuck_file.bf
```
To provide Brainfuck code as input:
```
brainfk
```
The interpreter will prompt you to enter the Brainfuck code. Type or paste the code, and press Enter.
Examples
--------
Here are some examples to demonstrate how to use Brainfk:
1. Execute Brainfuck code from a file:
```
brainfk examples/hello_world.bf
```
2. Execute Brainfuck code by providing input:
```
brainfk
```
Enter the Brainfuck code: `,.[.,]`
Enter the input: `Hello, Brainfuck!`
Development and Contributing
----------------------------
If you would like to contribute to Brainfk, feel free to open pull requests for bug fixes, enhancements, or new features. Please ensure that your code follows the existing coding style and includes appropriate tests.
License
-------
This project is licensed under the MIT License. See the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/estif0/brainfk",
"name": "brainfk",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,package,cli,interpreter,brainfuck",
"author": "Estifanose Sahilu",
"author_email": "<estifanoswork@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/43/a1/61e36c2fb4950093a5e4ef1c4c6a6a88088460380391470e4186c10ce956/brainfk-0.0.2.tar.gz",
"platform": null,
"description": "Brainfk\r\n=======\r\n\r\nBrainfk is a Python package that provides an interpreter for the Brainfuck programming language. It allows you to execute Brainfuck code and see the output.\r\n\r\nFeatures\r\n--------\r\n\r\n- Simple and intuitive interface to run Brainfuck code.\r\n- Supports reading Brainfuck code from a file or direct input.\r\n- Handles the basic Brainfuck commands: +, -, <, >, ., ,, [, ].\r\n- Supports nested loops in Brainfuck code.\r\n\r\nInstallation\r\n------------\r\n\r\nYou can install Brainfk using pip:\r\n\r\n```\r\npip install brainfk\r\n```\r\n\r\n\r\nBrainfk requires Python 3.7 or higher.\r\n\r\nUsage\r\n-----\r\n\r\nYou can run the Brainfuck interpreter by executing the `brainfk` command followed by the path to a file containing Brainfuck code or by providing the code directly as input.\r\n\r\nTo execute Brainfuck code from a file:\r\n\r\n```\r\nbrainfk path/to/brainfuck_file.bf\r\n```\r\n\r\nTo provide Brainfuck code as input:\r\n\r\n```\r\nbrainfk\r\n```\r\n\r\nThe interpreter will prompt you to enter the Brainfuck code. Type or paste the code, and press Enter.\r\n\r\nExamples\r\n--------\r\n\r\nHere are some examples to demonstrate how to use Brainfk:\r\n\r\n1. Execute Brainfuck code from a file:\r\n\r\n```\r\nbrainfk examples/hello_world.bf\r\n```\r\n\r\n2. Execute Brainfuck code by providing input:\r\n\r\n```\r\nbrainfk\r\n```\r\n\r\nEnter the Brainfuck code: `,.[.,]`\r\n\r\nEnter the input: `Hello, Brainfuck!`\r\n\r\nDevelopment and Contributing\r\n----------------------------\r\n\r\nIf you would like to contribute to Brainfk, feel free to open pull requests for bug fixes, enhancements, or new features. Please ensure that your code follows the existing coding style and includes appropriate tests.\r\n\r\nLicense\r\n-------\r\n\r\nThis project is licensed under the MIT License. See the LICENSE file for details.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A Brainfuck interpreter package",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/estif0/brainfk"
},
"split_keywords": [
"python",
"package",
"cli",
"interpreter",
"brainfuck"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "43a161e36c2fb4950093a5e4ef1c4c6a6a88088460380391470e4186c10ce956",
"md5": "21c3f79dab27f9fb8b3416c9b8c48eb0",
"sha256": "c134d884bfdd3b898239079fee15f0f3434971fdc55b5dd6cec687bac7b88ce9"
},
"downloads": -1,
"filename": "brainfk-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "21c3f79dab27f9fb8b3416c9b8c48eb0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3165,
"upload_time": "2023-06-10T18:00:13",
"upload_time_iso_8601": "2023-06-10T18:00:13.814866Z",
"url": "https://files.pythonhosted.org/packages/43/a1/61e36c2fb4950093a5e4ef1c4c6a6a88088460380391470e4186c10ce956/brainfk-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-10 18:00:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "estif0",
"github_project": "brainfk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "brainfk"
}
JSON
