velma

Name	velma JSON
Version	0.0.1 JSON
	download
home_page	None
Summary	Modern Reimplementation of vera built with C internals
upload_time	2024-07-18 19:54:07
maintainer	None
docs_url	None
author	Sigmanificient
requires_python	>=3.8
license	MIT
keywords	vera c_tokenizer
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # velma

Velma is the reimplementation of [vera](https://github.com/verateam/vera)
 python-API built with C internals.

## main differences

- Velma suppports python-based plugins while vera support both lua and python.
- It provides a python package built with setuptools and C extension rather than relying on `<boost/python.hpp>`. This avoid relying on the system python environment, and provide support for virtual env.
- Tokenization is done with C in mind rather than C++.

## Installation

Start by [cloning this repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).

### pip based

> [!NOTE]
> It is recommended to use python virtual env's rather than doing a system-wide install.
> See [Creation of virtual environments](https://docs.python.org/3/library/venv.html) for more information

```bash
# (in repository's root)
pip install .
```

### Using nix

The repository flake provides `velma` nix derivation (`buildPythonPackage`).

```
nix build github:Sigmanificient/velma
```

or creating a python env:

```nix
let
  # assuming `velma-flake.url = "github:Sigmanificient/velma"` in flake inputs
  velma = velma-flake.outputs.${system}.velma;
  selectPythonPackages = ps: [ velma ... ];
in 
(pkgs.python311.withPackages (ps: selectPythonPackages)
```

## Development

To see available commands in the Makefile, use the following:

```bash
make help
```

### Building a standalone shared object

If you need to build a standlone `shared object`:

```bash
make -f standalone_shared_object.mk
```

### IDE support (via compile_commands.json)

```bash
make compiledb
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "velma",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "vera, c_tokenizer",
    "author": "Sigmanificient",
    "author_email": "yohann.boniface@epitech.eu",
    "download_url": "https://files.pythonhosted.org/packages/20/71/e602ccdebde7571c0e3d7cec5fb9f4ce3ee14df8c17334c51b6605059849/velma-0.0.1.tar.gz",
    "platform": "unix",
    "description": "# velma\n\nVelma is the reimplementation of [vera](https://github.com/verateam/vera)\n python-API built with C internals.\n\n## main differences\n\n- Velma suppports python-based plugins while vera support both lua and python.\n- It provides a python package built with setuptools and C extension rather than relying on `<boost/python.hpp>`. This avoid relying on the system python environment, and provide support for virtual env.\n- Tokenization is done with C in mind rather than C++.\n\n## Installation\n\nStart by [cloning this repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).\n\n### pip based\n\n> [!NOTE]\n> It is recommended to use python virtual env's rather than doing a system-wide install.\n> See [Creation of virtual environments](https://docs.python.org/3/library/venv.html) for more information\n\n```bash\n# (in repository's root)\npip install .\n```\n\n### Using nix\n\nThe repository flake provides `velma` nix derivation (`buildPythonPackage`).\n\n```\nnix build github:Sigmanificient/velma\n```\n\nor creating a python env:\n\n```nix\nlet\n  # assuming `velma-flake.url = \"github:Sigmanificient/velma\"` in flake inputs\n  velma = velma-flake.outputs.${system}.velma;\n  selectPythonPackages = ps: [ velma ... ];\nin \n(pkgs.python311.withPackages (ps: selectPythonPackages)\n```\n\n## Development\n\nTo see available commands in the Makefile, use the following:\n\n```bash\nmake help\n```\n\n### Building a standalone shared object\n\nIf you need to build a standlone `shared object`:\n\n```bash\nmake -f standalone_shared_object.mk\n```\n\n### IDE support (via compile_commands.json)\n\n```bash\nmake compiledb\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Modern Reimplementation of vera built with C internals",
    "version": "0.0.1",
    "project_urls": null,
    "split_keywords": [
        "vera",
        " c_tokenizer"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2071e602ccdebde7571c0e3d7cec5fb9f4ce3ee14df8c17334c51b6605059849",
                "md5": "a7f77ceaf6093f8b1b20b3ac61fec647",
                "sha256": "9affcea371a1762bb513f20fc837873ad664e8bcfe90dd1c39f289b2914d6ae9"
            },
            "downloads": -1,
            "filename": "velma-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a7f77ceaf6093f8b1b20b3ac61fec647",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 3009,
            "upload_time": "2024-07-18T19:54:07",
            "upload_time_iso_8601": "2024-07-18T19:54:07.378661Z",
            "url": "https://files.pythonhosted.org/packages/20/71/e602ccdebde7571c0e3d7cec5fb9f4ce3ee14df8c17334c51b6605059849/velma-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-18 19:54:07",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "velma"
}