pyreka

Name	pyreka JSON
Version	1.0.1 JSON
	download
home_page
Summary	Package for finding python functions in codebases and environment packages
upload_time	2022-12-16 15:14:38
maintainer
docs_url	None
author
requires_python	>=3.10
license
keywords	search functions finder
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            ![logo](.images/logo.jpeg)

## :construction::wrench: Installation
```bash
pip install pyreka
```

## :page_with_curl: Usage
`pyreka` can be used to search functions using function names and docstrings in packages and directories.

For example to search in `numpy` the following commands could be issued from the command line.

Firstly, install numpy
```bash
pip install numpy
```

and then from the same environment search the numpy package for keywords:

```bash
pyreka numpy "sort array indices"
```

First you will be asked if you are searching a local directory or for a package in your environment, then you should see a number of functions returned, along with the file that they live in and the line number for each returned function you can also scroll their docstrings.

<center style="font-size: 26px">:confetti_ball:</center>

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pyreka",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "search,functions,finder",
    "author": "",
    "author_email": "George Allaway <george.w.allaway@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/6c/a8/43aaf151d01db90e16819863002ee158d00e234d1fb54952dfa28792e95d/pyreka-1.0.1.tar.gz",
    "platform": null,
    "description": "![logo](.images/logo.jpeg)\n\n## :construction::wrench: Installation\n```bash\npip install pyreka\n```\n\n## :page_with_curl: Usage\n`pyreka` can be used to search functions using function names and docstrings in packages and directories.\n\nFor example to search in `numpy` the following commands could be issued from the command line.\n\nFirstly, install numpy\n```bash\npip install numpy\n```\n\nand then from the same environment search the numpy package for keywords:\n\n```bash\npyreka numpy \"sort array indices\"\n```\n\nFirst you will be asked if you are searching a local directory or for a package in your environment, then you should see a number of functions returned, along with the file that they live in and the line number for each returned function you can also scroll their docstrings.\n\n<center style=\"font-size: 26px\">:confetti_ball:</center>\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Package for finding python functions in codebases and environment packages",
    "version": "1.0.1",
    "split_keywords": [
        "search",
        "functions",
        "finder"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "602d0fee20599fbf7af3b874d21084f3",
                "sha256": "05b0774b11360d97ddb15bcfc26fe5216173b7eabd94d76b39143c62f80b8a41"
            },
            "downloads": -1,
            "filename": "pyreka-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "602d0fee20599fbf7af3b874d21084f3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 3763,
            "upload_time": "2022-12-16T15:14:37",
            "upload_time_iso_8601": "2022-12-16T15:14:37.549932Z",
            "url": "https://files.pythonhosted.org/packages/9c/79/cb5a9d010e3c2f0de50c8fbfe873bb034ddc65781c8db28f23b7f47469f2/pyreka-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "7060f5639f2e7822c05a6e3fcbf858c0",
                "sha256": "79e90abf44f651d49b0735d8b506b8966364105c8cd606608ab70e66fa26dc88"
            },
            "downloads": -1,
            "filename": "pyreka-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "7060f5639f2e7822c05a6e3fcbf858c0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 3561,
            "upload_time": "2022-12-16T15:14:38",
            "upload_time_iso_8601": "2022-12-16T15:14:38.774928Z",
            "url": "https://files.pythonhosted.org/packages/6c/a8/43aaf151d01db90e16819863002ee158d00e234d1fb54952dfa28792e95d/pyreka-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-16 15:14:38",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "pyreka"
}