heliokos


Nameheliokos JSON
Version 0.0.10 PyPI version JSON
download
home_page
SummaryA knowledge organization system (KOS) service for Heliophysics
upload_time2023-10-20 15:54:02
maintainer
docs_urlNone
author
requires_python>=3.11
license
keywords rdf skos
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # heliokos
A knowledge organization system (KOS) service for Heliophysics.

# use

Executable [functional tests](tests/test_functions.py) describe target use cases. Currently, the first two tests pass,
so you can follow their bodies as usage examples. The rest of the functional test suite can be considered a roadmap
for this tool.

You can `pip install heliokos` to get the last-released version,
or you can `git clone` this repository and `pip install .` to build the tool using the current `main`-branch head.

# development

`git clone` this repository, and in the root directory,
```bash
pip install -e .
```

## bill of materials (BOM)

|name|description|website|origin|
|----|-----------|-------|------|
|fastapi|API framework|https://github.com/tiangolo/fastapi | https://pypi.org/project/fastapi |
|rdflib|RDF graph library|https://github.com/RDFLib/rdflib | https://pypi.org/project/rdflib |
|toolz|utility functions library|https://github.com/pytoolz/toolz | https://pypi.org/project/toolz |


To start the Web server for development:
```bash
uvicorn heliokos.ui.main:app --reload
```

# testing

```bash
# Example: run linting and tests for single module
tox run -e lint,py311 -- tests/test_units.py
# Example run single test by name
tox run -e py311 -- -k test_harmonizing_two_concept_schemes
# Example: run all tests
tox
```

# release process

1. bump `version` in [pyproject.toml](/pyproject.toml).
2. git commit
3. git tag v$(pyproject.toml.version) # e.g. `git tag v0.0.5`.
4. python -m build
5. python -m twine upload dist/*
6. rm -rf dist

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "heliokos",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "",
    "keywords": "RDF,SKOS",
    "author": "",
    "author_email": "Donny Winston <donny@polyneme.xyz>",
    "download_url": "https://files.pythonhosted.org/packages/a6/82/3d262d294f8be4cb5d7c02f7dd4498eaafb162c7a93496ca547ab9e89813/heliokos-0.0.10.tar.gz",
    "platform": null,
    "description": "# heliokos\nA knowledge organization system (KOS) service for Heliophysics.\n\n# use\n\nExecutable [functional tests](tests/test_functions.py) describe target use cases. Currently, the first two tests pass,\nso you can follow their bodies as usage examples. The rest of the functional test suite can be considered a roadmap\nfor this tool.\n\nYou can `pip install heliokos` to get the last-released version,\nor you can `git clone` this repository and `pip install .` to build the tool using the current `main`-branch head.\n\n# development\n\n`git clone` this repository, and in the root directory,\n```bash\npip install -e .\n```\n\n## bill of materials (BOM)\n\n|name|description|website|origin|\n|----|-----------|-------|------|\n|fastapi|API framework|https://github.com/tiangolo/fastapi | https://pypi.org/project/fastapi |\n|rdflib|RDF graph library|https://github.com/RDFLib/rdflib | https://pypi.org/project/rdflib |\n|toolz|utility functions library|https://github.com/pytoolz/toolz | https://pypi.org/project/toolz |\n\n\nTo start the Web server for development:\n```bash\nuvicorn heliokos.ui.main:app --reload\n```\n\n# testing\n\n```bash\n# Example: run linting and tests for single module\ntox run -e lint,py311 -- tests/test_units.py\n# Example run single test by name\ntox run -e py311 -- -k test_harmonizing_two_concept_schemes\n# Example: run all tests\ntox\n```\n\n# release process\n\n1. bump `version` in [pyproject.toml](/pyproject.toml).\n2. git commit\n3. git tag v$(pyproject.toml.version) # e.g. `git tag v0.0.5`.\n4. python -m build\n5. python -m twine upload dist/*\n6. rm -rf dist\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A knowledge organization system (KOS) service for Heliophysics",
    "version": "0.0.10",
    "project_urls": {
        "Bug Tracker": "https://github.com/polyneme/heliokos/issues",
        "Homepage": "https://github.com/polyneme/heliokos"
    },
    "split_keywords": [
        "rdf",
        "skos"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4894e1491910300e1c568ebbc2acbb84695c35a96c544782571d73fb224d09fd",
                "md5": "0c9594e2cacd2b541c7e05a0886245e3",
                "sha256": "dbaa32e005445727bda4fd8c7da0db7fa9ad088035a3958e1092667af4a733d9"
            },
            "downloads": -1,
            "filename": "heliokos-0.0.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0c9594e2cacd2b541c7e05a0886245e3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 2592188,
            "upload_time": "2023-10-20T15:53:58",
            "upload_time_iso_8601": "2023-10-20T15:53:58.759570Z",
            "url": "https://files.pythonhosted.org/packages/48/94/e1491910300e1c568ebbc2acbb84695c35a96c544782571d73fb224d09fd/heliokos-0.0.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a6823d262d294f8be4cb5d7c02f7dd4498eaafb162c7a93496ca547ab9e89813",
                "md5": "0e6e30bc5225e3c07a4a5ff5d517542e",
                "sha256": "579849f82f54e19ff85ec98303fae0861227e8e9146390946e6d13edac2e4e9a"
            },
            "downloads": -1,
            "filename": "heliokos-0.0.10.tar.gz",
            "has_sig": false,
            "md5_digest": "0e6e30bc5225e3c07a4a5ff5d517542e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 2510111,
            "upload_time": "2023-10-20T15:54:02",
            "upload_time_iso_8601": "2023-10-20T15:54:02.365060Z",
            "url": "https://files.pythonhosted.org/packages/a6/82/3d262d294f8be4cb5d7c02f7dd4498eaafb162c7a93496ca547ab9e89813/heliokos-0.0.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-20 15:54:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "polyneme",
    "github_project": "heliokos",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "tox": true,
    "lcname": "heliokos"
}
        
Elapsed time: 0.12452s