arcon
=====
.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT
:alt: License
.. image:: https://img.shields.io/pypi/v/arcon
:target: https://pypi.org/project/arcon/
:alt: PyPI
.. image:: https://github.com/jshwi/arcon/actions/workflows/build.yaml/badge.svg
:target: https://github.com/jshwi/arcon/actions/workflows/build.yaml
:alt: Build
.. image:: https://github.com/jshwi/arcon/actions/workflows/codeql-analysis.yml/badge.svg
:target: https://github.com/jshwi/arcon/actions/workflows/codeql-analysis.yml
:alt: CodeQL
.. image:: https://results.pre-commit.ci/badge/github/jshwi/arcon/master.svg
:target: https://results.pre-commit.ci/latest/github/jshwi/arcon/master
:alt: pre-commit.ci status
.. image:: https://codecov.io/gh/jshwi/arcon/branch/master/graph/badge.svg
:target: https://codecov.io/gh/jshwi/arcon
:alt: codecov.io
.. image:: https://readthedocs.org/projects/arcon/badge/?version=latest
:target: https://arcon.readthedocs.io/en/latest/?badge=latest
:alt: readthedocs.org
.. image:: https://img.shields.io/badge/python-3.8-blue.svg
:target: https://www.python.org/downloads/release/python-380
:alt: python3.8
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Black
.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
:target: https://pycqa.github.io/isort/
:alt: isort
.. image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg
:target: https://github.com/PyCQA/docformatter
:alt: docformatter
.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen
:target: https://github.com/PyCQA/pylint
:alt: pylint
.. image:: https://img.shields.io/badge/security-bandit-yellow.svg
:target: https://github.com/PyCQA/bandit
:alt: Security Status
.. image:: https://snyk.io/test/github/jshwi/arcon/badge.svg
:target: https://snyk.io/test/github/jshwi/arcon/badge.svg
:alt: Known Vulnerabilities
.. image:: https://snyk.io/advisor/python/arcon/badge.svg
:target: https://snyk.io/advisor/python/arcon
:alt: arcon
Persistent runtime config
-------------------------
Child class of ``argparse.ArgumentParser``
Includes version argument as a default
Default values are defined through pyproject.toml
Includes additional argument adding methods
.. code-block:: python
>>> __version__ = "0.1.0"
>>> from arcon import ArgumentParser
Parsing comma separated list
.. code-block:: python
>>> parser = ArgumentParser(__version__)
>>> parser.add_list_argument("-l", "--list")
>>> parser.parse_args(["--list", "comma,separated,list"])
Namespace(list=['comma', 'separated', 'list'])
Parsing dict of comma separated lists
.. code-block:: python
>>> parser = ArgumentParser(__version__)
>>> parser.add_dict_argument("-d", "--dict")
>>> parser.parse_args(["--dict", "key=comma,separated,list"])
Namespace(dict={'key': ['comma', 'separated', 'list']})
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/arcon/",
"name": "arcon",
"maintainer": "jshwi",
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": "stephen@jshwisolutions.com",
"keywords": "arguments, config, params, parser, runtime",
"author": "jshwi",
"author_email": "stephen@jshwisolutions.com",
"download_url": "https://files.pythonhosted.org/packages/5b/e7/26fec91ce4ea7a91f7e21d786d060d6e9f515a9338623e4f2c0efcd86995/arcon-0.4.0.tar.gz",
"platform": null,
"description": "arcon\n=====\n.. image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: License\n.. image:: https://img.shields.io/pypi/v/arcon\n :target: https://pypi.org/project/arcon/\n :alt: PyPI\n.. image:: https://github.com/jshwi/arcon/actions/workflows/build.yaml/badge.svg\n :target: https://github.com/jshwi/arcon/actions/workflows/build.yaml\n :alt: Build\n.. image:: https://github.com/jshwi/arcon/actions/workflows/codeql-analysis.yml/badge.svg\n :target: https://github.com/jshwi/arcon/actions/workflows/codeql-analysis.yml\n :alt: CodeQL\n.. image:: https://results.pre-commit.ci/badge/github/jshwi/arcon/master.svg\n :target: https://results.pre-commit.ci/latest/github/jshwi/arcon/master\n :alt: pre-commit.ci status\n.. image:: https://codecov.io/gh/jshwi/arcon/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/jshwi/arcon\n :alt: codecov.io\n.. image:: https://readthedocs.org/projects/arcon/badge/?version=latest\n :target: https://arcon.readthedocs.io/en/latest/?badge=latest\n :alt: readthedocs.org\n.. image:: https://img.shields.io/badge/python-3.8-blue.svg\n :target: https://www.python.org/downloads/release/python-380\n :alt: python3.8\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black\n.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336\n :target: https://pycqa.github.io/isort/\n :alt: isort\n.. image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg\n :target: https://github.com/PyCQA/docformatter\n :alt: docformatter\n.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen\n :target: https://github.com/PyCQA/pylint\n :alt: pylint\n.. image:: https://img.shields.io/badge/security-bandit-yellow.svg\n :target: https://github.com/PyCQA/bandit\n :alt: Security Status\n.. image:: https://snyk.io/test/github/jshwi/arcon/badge.svg\n :target: https://snyk.io/test/github/jshwi/arcon/badge.svg\n :alt: Known Vulnerabilities\n.. image:: https://snyk.io/advisor/python/arcon/badge.svg\n :target: https://snyk.io/advisor/python/arcon\n :alt: arcon\n\nPersistent runtime config\n-------------------------\n\nChild class of ``argparse.ArgumentParser``\n\nIncludes version argument as a default\n\nDefault values are defined through pyproject.toml\n\nIncludes additional argument adding methods\n\n.. code-block:: python\n\n >>> __version__ = \"0.1.0\"\n >>> from arcon import ArgumentParser\n\nParsing comma separated list\n\n.. code-block:: python\n\n >>> parser = ArgumentParser(__version__)\n >>> parser.add_list_argument(\"-l\", \"--list\")\n >>> parser.parse_args([\"--list\", \"comma,separated,list\"])\n Namespace(list=['comma', 'separated', 'list'])\n\nParsing dict of comma separated lists\n\n.. code-block:: python\n\n >>> parser = ArgumentParser(__version__)\n >>> parser.add_dict_argument(\"-d\", \"--dict\")\n >>> parser.parse_args([\"--dict\", \"key=comma,separated,list\"])\n Namespace(dict={'key': ['comma', 'separated', 'list']})\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Persistent runtime config",
"version": "0.4.0",
"project_urls": {
"Documentation": "https://arcon.readthedocs.io/en/latest",
"Homepage": "https://pypi.org/project/arcon/",
"Repository": "https://github.com/jshwi/arcon"
},
"split_keywords": [
"arguments",
" config",
" params",
" parser",
" runtime"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7250f1afe9243c872454e9273b95616ab5d4ca795ca8c5675d21db473b2f6bef",
"md5": "7f24109f9bf0a265699bb3aba9df6c87",
"sha256": "19488bca11b6facb59c2d3f587e8685aa6afc99764b0956fa2c2837fc0fff6a9"
},
"downloads": -1,
"filename": "arcon-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f24109f9bf0a265699bb3aba9df6c87",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 5462,
"upload_time": "2024-04-09T04:11:55",
"upload_time_iso_8601": "2024-04-09T04:11:55.067180Z",
"url": "https://files.pythonhosted.org/packages/72/50/f1afe9243c872454e9273b95616ab5d4ca795ca8c5675d21db473b2f6bef/arcon-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5be726fec91ce4ea7a91f7e21d786d060d6e9f515a9338623e4f2c0efcd86995",
"md5": "509379342d9d197808f5c71f0e0b3834",
"sha256": "b243f265d5f1eacf0025d072ef4d3385b0f33c20b247d017a25948b3b19805b1"
},
"downloads": -1,
"filename": "arcon-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "509379342d9d197808f5c71f0e0b3834",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 5358,
"upload_time": "2024-04-09T04:11:56",
"upload_time_iso_8601": "2024-04-09T04:11:56.660370Z",
"url": "https://files.pythonhosted.org/packages/5b/e7/26fec91ce4ea7a91f7e21d786d060d6e9f515a9338623e4f2c0efcd86995/arcon-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 04:11:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jshwi",
"github_project": "arcon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "arcon"
}
JSON
