kiara-plugin.network-analysis


Namekiara-plugin.network-analysis JSON
Version 0.5.2 PyPI version JSON
download
home_pageNone
SummaryNetwork-related data-types, modules and pipelines for kiara.
upload_time2025-07-20 12:52:42
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMPL-2.0
keywords kiara kiara-plugin
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            [![PyPI status](https://img.shields.io/pypi/status/kiara_plugin.network_analysis.svg)](https://pypi.python.org/pypi/kiara_plugin.network_analysis/)
[![PyPI version](https://img.shields.io/pypi/v/kiara_plugin.network_analysis.svg)](https://pypi.python.org/pypi/kiara_plugin.network_analysis/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/kiara_plugin.network_analysis.svg)](https://pypi.python.org/pypi/kiara_plugin.network_analysis/)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FDHARPA-Project%2Fkiara%2Fbadge%3Fref%3Ddevelop&style=flat)](https://actions-badge.atrox.dev/DHARPA-Project/kiara_plugin.network_analysis/goto?ref=develop)
[![Coverage Status](https://coveralls.io/repos/github/DHARPA-Project/kiara_plugin.network_analysis/badge.svg?branch=develop)](https://coveralls.io/github/DHARPA-Project/kiara_plugin.network_analysis?branch=develop)
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

# [**kiara**](https://dharpa.org/kiara.documentation) plugin: (network_analysis)

Network-related data-types, modules and pipelines for kiara.

 - Documentation: [https://DHARPA-Project.github.io/kiara_plugin.network_analysis](https://DHARPA-Project.github.io/kiara_plugin.network_analysis)
 - Code: [https://github.com/DHARPA-Project/kiara_plugin.network_analysis](https://github.com/DHARPA-Project/kiara_plugin.network_analysis)
 - `kiara`: [https://docs.dharpa.org](https://docs.dharpa.org)

## Description

TODO

## Development

### Requirements

- uv ( https://docs.astral.sh/uv/ )
- git
- make (on Linux / Mac OS X -- optional)

### Check out the source code & enter the project directory

```
git clone https://github.com/DHARPA-Project/kiara_plugin.network_analysis
cd kiara_plugin.network_analysis
```

### Prepare development environment

The recommended way to setup a development environment is to use [uv](https://docs.astral.sh/uv/). Check out [their install instructions](https://docs.astral.sh/uv/getting-started/installation/).

Once you have `uv` installed, you can either run `kiara` using the `uv run` command:

```
uv run kiara module list
```

or, activate the virtual environment and run `kiara` directly:

```
uv sync  # to make sure the virtualenv exists (and is up to date)
source .venv/bin/activate
kiara module list
```

### Run one of the included notebooks

For any of the [marimo](https://marimo.io/) under `docs/notebooks/marimo`, you can run them with:

```
uv run marimo edit docs/notebooks/marimo/getting_started.py
```

Likewise, for the [jupyter](https://jupyter.org/) notebooks you can run them with:
```
uv run jupyter lab docs/notebooks/jupyter/getting_started.ipynb
```

### Running pre-defined development-related tasks

The included `Makefile` file includes some useful tasks that help with development. This requires `uv` and the `make` tool to be
installed, which should be the case for Linux & Mac OS X systems.

- `make test`: runs the unit tests
- `make mypy`: run mypy checks
- `make lint`: run the `ruff` linter on the source code
- `make format`: run the `ruff` formatter on the source code (similar to `black`)
- `make docs`: build the documentation  (into `build` folder)
- `make docs-serve`: serve the documentation (on port 8000)

Alternatively, if you don't have the `make` command available, you can use `uv` directly to run those tasks:

- `uv run pytest tests`
- `uv run mypy src/`
- `uv run ruff check --fix src/`
- `uv run ruff format src/`

## Copyright & license

This project is MPL v2.0 licensed, for the license text please check the [LICENSE](/LICENSE) file in this repository.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "kiara-plugin.network-analysis",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "kiara, kiara-plugin",
    "author": null,
    "author_email": "Markus Binsteiner <markus@frkl.dev>",
    "download_url": "https://files.pythonhosted.org/packages/42/12/a0a76decf1b4594bf17df67b96d7f66c8367cae0a6bfc6d162b44227bb19/kiara_plugin_network_analysis-0.5.2.tar.gz",
    "platform": null,
    "description": "[![PyPI status](https://img.shields.io/pypi/status/kiara_plugin.network_analysis.svg)](https://pypi.python.org/pypi/kiara_plugin.network_analysis/)\n[![PyPI version](https://img.shields.io/pypi/v/kiara_plugin.network_analysis.svg)](https://pypi.python.org/pypi/kiara_plugin.network_analysis/)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/kiara_plugin.network_analysis.svg)](https://pypi.python.org/pypi/kiara_plugin.network_analysis/)\n[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FDHARPA-Project%2Fkiara%2Fbadge%3Fref%3Ddevelop&style=flat)](https://actions-badge.atrox.dev/DHARPA-Project/kiara_plugin.network_analysis/goto?ref=develop)\n[![Coverage Status](https://coveralls.io/repos/github/DHARPA-Project/kiara_plugin.network_analysis/badge.svg?branch=develop)](https://coveralls.io/github/DHARPA-Project/kiara_plugin.network_analysis?branch=develop)\n[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n# [**kiara**](https://dharpa.org/kiara.documentation) plugin: (network_analysis)\n\nNetwork-related data-types, modules and pipelines for kiara.\n\n - Documentation: [https://DHARPA-Project.github.io/kiara_plugin.network_analysis](https://DHARPA-Project.github.io/kiara_plugin.network_analysis)\n - Code: [https://github.com/DHARPA-Project/kiara_plugin.network_analysis](https://github.com/DHARPA-Project/kiara_plugin.network_analysis)\n - `kiara`: [https://docs.dharpa.org](https://docs.dharpa.org)\n\n## Description\n\nTODO\n\n## Development\n\n### Requirements\n\n- uv ( https://docs.astral.sh/uv/ )\n- git\n- make (on Linux / Mac OS X -- optional)\n\n### Check out the source code & enter the project directory\n\n```\ngit clone https://github.com/DHARPA-Project/kiara_plugin.network_analysis\ncd kiara_plugin.network_analysis\n```\n\n### Prepare development environment\n\nThe recommended way to setup a development environment is to use [uv](https://docs.astral.sh/uv/). Check out [their install instructions](https://docs.astral.sh/uv/getting-started/installation/).\n\nOnce you have `uv` installed, you can either run `kiara` using the `uv run` command:\n\n```\nuv run kiara module list\n```\n\nor, activate the virtual environment and run `kiara` directly:\n\n```\nuv sync  # to make sure the virtualenv exists (and is up to date)\nsource .venv/bin/activate\nkiara module list\n```\n\n### Run one of the included notebooks\n\nFor any of the [marimo](https://marimo.io/) under `docs/notebooks/marimo`, you can run them with:\n\n```\nuv run marimo edit docs/notebooks/marimo/getting_started.py\n```\n\nLikewise, for the [jupyter](https://jupyter.org/) notebooks you can run them with:\n```\nuv run jupyter lab docs/notebooks/jupyter/getting_started.ipynb\n```\n\n### Running pre-defined development-related tasks\n\nThe included `Makefile` file includes some useful tasks that help with development. This requires `uv` and the `make` tool to be\ninstalled, which should be the case for Linux & Mac OS X systems.\n\n- `make test`: runs the unit tests\n- `make mypy`: run mypy checks\n- `make lint`: run the `ruff` linter on the source code\n- `make format`: run the `ruff` formatter on the source code (similar to `black`)\n- `make docs`: build the documentation  (into `build` folder)\n- `make docs-serve`: serve the documentation (on port 8000)\n\nAlternatively, if you don't have the `make` command available, you can use `uv` directly to run those tasks:\n\n- `uv run pytest tests`\n- `uv run mypy src/`\n- `uv run ruff check --fix src/`\n- `uv run ruff format src/`\n\n## Copyright & license\n\nThis project is MPL v2.0 licensed, for the license text please check the [LICENSE](/LICENSE) file in this repository.\n",
    "bugtrack_url": null,
    "license": "MPL-2.0",
    "summary": "Network-related data-types, modules and pipelines for kiara.",
    "version": "0.5.2",
    "project_urls": {
        "documentation": "https://DHARPA-Project.github.io/kiara_plugin.network_analysis",
        "homepage": "https://github.com/DHARPA-Project/kiara_plugin.network_analysis",
        "repository": "https://github.com/DHARPA-Project/kiara_plugin.network_analysis"
    },
    "split_keywords": [
        "kiara",
        " kiara-plugin"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "21e67c5b627959df83d25b3f58e8418a4b44a12c060f962ac329e82a4031d349",
                "md5": "45187f2c0bdda0dc9791ffcb2c2e1080",
                "sha256": "f6e81622d377a2caf73829490acace7324a1f56cef38a8ed5019a98624264d7a"
            },
            "downloads": -1,
            "filename": "kiara_plugin_network_analysis-0.5.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "45187f2c0bdda0dc9791ffcb2c2e1080",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 42194,
            "upload_time": "2025-07-20T12:52:40",
            "upload_time_iso_8601": "2025-07-20T12:52:40.968615Z",
            "url": "https://files.pythonhosted.org/packages/21/e6/7c5b627959df83d25b3f58e8418a4b44a12c060f962ac329e82a4031d349/kiara_plugin_network_analysis-0.5.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4212a0a76decf1b4594bf17df67b96d7f66c8367cae0a6bfc6d162b44227bb19",
                "md5": "9692e604e461dff6713adf17b14220d0",
                "sha256": "a2bb3bd98e9c8fd075f98fa3d1c61da03a12466f72d34ae4ab62c4bcfc416740"
            },
            "downloads": -1,
            "filename": "kiara_plugin_network_analysis-0.5.2.tar.gz",
            "has_sig": false,
            "md5_digest": "9692e604e461dff6713adf17b14220d0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 141207,
            "upload_time": "2025-07-20T12:52:42",
            "upload_time_iso_8601": "2025-07-20T12:52:42.449387Z",
            "url": "https://files.pythonhosted.org/packages/42/12/a0a76decf1b4594bf17df67b96d7f66c8367cae0a6bfc6d162b44227bb19/kiara_plugin_network_analysis-0.5.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-20 12:52:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DHARPA-Project",
    "github_project": "kiara_plugin.network_analysis",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "kiara-plugin.network-analysis"
}
None
Elapsed time: 2.06389s