{"id":13596230,"url":"https://github.com/Almenon/AREPL-vscode","last_synced_at":"2025-04-09T16:31:52.023Z","repository":{"id":44454362,"uuid":"117485799","full_name":"Almenon/AREPL-vscode","owner":"Almenon","description":"Program python in real-time","archived":false,"fork":false,"pushed_at":"2024-11-19T05:50:55.000Z","size":2733,"stargazers_count":283,"open_issues_count":139,"forks_count":37,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-08T09:07:28.194Z","etag":null,"topics":["hacktoberfest","python","real-time","vscode-extension"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Almenon.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"almenon","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-01-15T02:09:48.000Z","updated_at":"2025-04-03T18:04:45.000Z","dependencies_parsed_at":"2024-06-03T04:09:32.549Z","dependency_job_id":"dc787128-1f23-47f7-926d-f85a48a58842","html_url":"https://github.com/Almenon/AREPL-vscode","commit_stats":{"total_commits":743,"total_committers":7,"mean_commits":"106.14285714285714","dds":"0.24360699865410496","last_synced_commit":"72df23bdadc8c624b02386da0b38b6bfa0a9962a"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Almenon%2FAREPL-vscode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Almenon%2FAREPL-vscode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Almenon%2FAREPL-vscode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Almenon%2FAREPL-vscode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Almenon","download_url":"https://codeload.github.com/Almenon/AREPL-vscode/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247809962,"owners_count":20999816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","python","real-time","vscode-extension"],"created_at":"2024-08-01T16:02:12.785Z","updated_at":"2025-04-09T16:31:52.017Z","avatar_url":"https://github.com/Almenon.png","language":"TypeScript","readme":"## AREPL [![Build Status](https://github.com/Almenon/AREPL-vscode/workflows/.github/workflows/main.yml/badge.svg?branch=master)](https://github.com/Almenon/AREPL-vscode/actions?query=workflow%3A.github%2Fworkflows%2Fmain.yml) [![Gitter chat](https://badges.gitter.im/arepl/gitter.png)](https://gitter.im/arepl/lobby)\n\nAREPL automatically evaluates python code in real-time as you type.\n\n![The demo gif is a bit outdated](https://raw.githubusercontent.com/Almenon/AREPL-vscode/master/areplDemoGif2.gif)\n\nAREPL is availible for free on the vscode [marketplace](https://marketplace.visualstudio.com/items?itemName=almenon.arepl#overview).\n\n## Usage\n\nFirst, make sure you have [python 3.7 or greater](https://www.python.org/downloads/) installed.\n\nOpen a python file and click on the cat ![cat](./media/happy_cat_24.png)  in the top bar to the right to open AREPL. You can click the cat again to close.\n\nOr run AREPL through the command search: `control-shift-p`\n\nor use the shortcuts: `control-shift-a` (current doc) / `control-shift-q` (new doc)\n\n## Features\n\n* Real-time evaluation: no need to run - AREPL evaluates your code automatically. You can control this (or even turn it off) in the settings.\n\n* Variable display: The final state of your local variables are displayed in a collapsible JSON format.\n\n* Error display: The instant you make a mistake an error with stack trace is shown.\n\n* Settings: AREPL offers many settings to fit your user experience.  Customize the look and feel, debounce time, python options, and more!\n\n## Misc\n\n### Dumping\n\nIf you want to dump local variables or dump variables at a specific point in your program you can use the dump function:\n\n```python\nfrom arepl_dump import dump\n\ndef milesToKilometers(miles):\n    kilometers = miles*1.60934\n    dump() # dumps all the vars in your function when the function is called the first time\n\n    # or dump when function is called for a second time\n    dump(None,1)\n\nmilesToKilometers(2*2)\nmilesToKilometers(3*3)\n\nfor char in ['a','b','c']:\n    dump(char,2) # dump a var at a specific iteration\n\na=1\ndump(a) # dump specific vars at any point in your program\na=2\n```\n\n### STDIN\n\nsee https://github.com/Almenon/AREPL-vscode/wiki/Using-AREPL-with-input\n\n### GUIS\n\nsee https://github.com/Almenon/AREPL-vscode/wiki/Using-AREPL-with-GUI's\n\n### #$end\n\nUse the `#$end` comment to indicate the end of the real-time code. Code after `#$end` will not be executed in real-time.\nThis is useful if you have something specific you want to run without running the entire file along with it. For example:\n\n```python\nx = calculate_all_digits_of_pi()\n\n#$end\n\n# I can inspect variables without rerunning calculate_all_digits_of_pi\n# the shortcut is control-enter - the code block should flash yellow.\nprint(x) # 3.14......\n\n# I can also temporarily change the state of variables\n# note that control-enter will run all adjacent lines of code\nx = math.floor(x)\nprint(x) # 3\n\n# i only want to do this once I've determined that x is correct\nupload_results_to_s3(x)\n```\n\nNote that you can also use control-enter to run a block of code outside `#$end`.\n\n### Filtering variables from display\n\nDon't want to see a variable in AREPL's result panel?\nJust add it to a variable named `arepl_filter`:\n\n```python\narepl_filter = ['a']\na = \"foo\" # this won't show up\nb = 3 # this does\n```\n\nYou can also filter out types:\n\n```python\narepl_filter_type=[\"\u003cclass 'str'\u003e\"]\nc = \"foo\" # this won't show up\nc = 3 # this does\n```\n\nFinally there is a super-powerful arepl_filter_function var you can use to totally customize what is shown:\n\n```python\nfrom collections import namedtuple\n\nPoint = namedtuple('Point', ['x', 'y'])\np = Point(x=1, y=1)\n\ndef arepl_filter_function(var_dict):\n    var_dict['p']=var_dict['p'].x + var_dict['p'].y\n    return var_dict\n\n# p will show up as 2\n```\n\nYou can set default filters via the `defaultFilterVars` or `defaultFilterTypes` settings.\n\n### HOWDOI\n\nYou can use [howdoi](https://github.com/gleitz/howdoi) with arepl.\n\nFirst install in the terminal / command line:\n\n\u003e pip install howdoi\n\nThen reopen arepl and you will be able to use howdoi to get answers to your questions. For example:\n\n```python\nhowdoi('calculate fibbonaci in python')\n```\n\n will give you a function to calcualate a fibonaci number\n\n### Variable Representation\n\nI have [overridden the display](https://github.com/Almenon/AREPL-backend/blob/master/python/arepl_custom_handlers.py) of some types (like datetime) to be more readable to humans.\n\nIf you want a type to be displayed in a particular manner just [file an issue](https://github.com/Almenon/AREPL-vscode/issues)\n\n\n### More Stuff\n\nCheck out the [wiki](https://github.com/Almenon/AREPL-vscode/wiki)!\n\n#### Contributing to the project\n\nSee the [wiki page](https://github.com/Almenon/AREPL-vscode/wiki/Getting-Started-for-contributors-to-AREPL) on getting started. Contributions welcome! Even though the project is not actively developed on I still review pull requests and issues.\n","funding_links":["https://ko-fi.com/almenon"],"categories":["TypeScript","Libraries and tools"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlmenon%2FAREPL-vscode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAlmenon%2FAREPL-vscode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlmenon%2FAREPL-vscode/lists"}