==============================
varST(var ➡️ reStructuredText)
==============================
|PyPI version| |Github Actions| |pre-commit.ci status| |GitHub Workflow Status| |Documentation Status|
Replace substitutions in rst files with variables.
Getting Started
===============
cli
-------
See |Quickstart Documentation Page|_.
.. code:: bash
$ pip install varst
$ varst -h # --help
Github Actions
--------------
varST can be integrated with ``Github Actions``.
Please refer to this link_ and apply it to your own workflows.
Contributing
============
Contribution Guideline
----------------------
Please read the |contributing guidelines|_ to learn how to contribute to this project.
Reporting Issues
----------------
If you have any questions, suggestions, or bug reports, please feel free to report them to the issue.
Code of Conduct
---------------
This project is governed by the |code of conduct|_.
License
=======
`MIT
License <https://github.com/junghoon-vans/varst/blob/main/LICENSE>`__
.. |Quickstart Documentation Page| replace:: quickstart documentation
.. _Quickstart Documentation Page: https://varst.readthedocs.io/en/latest/index.html#quickstart
.. |PyPI version| image:: https://img.shields.io/pypi/v/varst
:target: https://pypi.org/project/varst/
.. |Github Actions| image:: https://img.shields.io/badge/Actions-black?logo=github
:target: https://github.com/marketplace/actions/rst-substitution
.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/junghoon-vans/varst/main.svg
:target: https://results.pre-commit.ci/latest/github/junghoon-vans/varst/main
.. |GitHub Workflow Status| image:: https://img.shields.io/github/actions/workflow/status/junghoon-vans/varst/python-publish.yml?branch=v1.6.0
.. |Documentation Status| image:: https://readthedocs.org/projects/varst/badge/?version=latest
:target: https://varst.readthedocs.io/en/latest/?badge=latest
.. _link: https://github.com/marketplace/actions/rst-substitution
.. |contributing guidelines| replace:: contributing guidelines
.. _contributing guidelines: ./CONTRIBUTING.md
.. |code of conduct| replace:: Code of Conduct
.. _Code Of Conduct: ./CODE_OF_CONDUCT.md
Raw data
{
"_id": null,
"home_page": "https://github.com/junghoon-vans/varst",
"name": "varst",
"maintainer": "junghoon-vans",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "junghoon.ban@gmail.com",
"keywords": "rst,reST,reStructuredText,replace,substitution",
"author": "junghoon-vans",
"author_email": "junghoon.ban@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/15/0b/01da2769e5e77e80be1026427f6b6eff6390a1d339d4c290540e0590ff2f/varst-1.6.0.tar.gz",
"platform": null,
"description": "==============================\nvarST(var \u27a1\ufe0f reStructuredText)\n==============================\n\n|PyPI version| |Github Actions| |pre-commit.ci status| |GitHub Workflow Status| |Documentation Status|\n\nReplace substitutions in rst files with variables.\n\nGetting Started\n===============\n\ncli\n-------\n\n See |Quickstart Documentation Page|_.\n\n.. code:: bash\n\n $ pip install varst\n $ varst -h # --help\n\nGithub Actions\n--------------\n\nvarST can be integrated with ``Github Actions``.\nPlease refer to this link_ and apply it to your own workflows.\n\nContributing\n============\n\nContribution Guideline\n----------------------\n\nPlease read the |contributing guidelines|_ to learn how to contribute to this project.\n\nReporting Issues\n----------------\n\nIf you have any questions, suggestions, or bug reports, please feel free to report them to the issue.\n\nCode of Conduct\n---------------\n\nThis project is governed by the |code of conduct|_.\n\nLicense\n=======\n\n`MIT\nLicense <https://github.com/junghoon-vans/varst/blob/main/LICENSE>`__\n\n.. |Quickstart Documentation Page| replace:: quickstart documentation\n.. _Quickstart Documentation Page: https://varst.readthedocs.io/en/latest/index.html#quickstart\n\n.. |PyPI version| image:: https://img.shields.io/pypi/v/varst\n :target: https://pypi.org/project/varst/\n.. |Github Actions| image:: https://img.shields.io/badge/Actions-black?logo=github\n :target: https://github.com/marketplace/actions/rst-substitution\n.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/junghoon-vans/varst/main.svg\n :target: https://results.pre-commit.ci/latest/github/junghoon-vans/varst/main\n.. |GitHub Workflow Status| image:: https://img.shields.io/github/actions/workflow/status/junghoon-vans/varst/python-publish.yml?branch=v1.6.0\n.. |Documentation Status| image:: https://readthedocs.org/projects/varst/badge/?version=latest\n :target: https://varst.readthedocs.io/en/latest/?badge=latest\n\n.. _link: https://github.com/marketplace/actions/rst-substitution\n\n.. |contributing guidelines| replace:: contributing guidelines\n.. _contributing guidelines: ./CONTRIBUTING.md\n.. |code of conduct| replace:: Code of Conduct\n.. _Code Of Conduct: ./CODE_OF_CONDUCT.md\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Replace substitutions in rst files with variables.",
"version": "1.6.0",
"split_keywords": [
"rst",
"rest",
"restructuredtext",
"replace",
"substitution"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73cc155e389978b6e38b612d7d7cfaab7e15c050a258e707889b541a73cb463a",
"md5": "f5f27c169b4763e7f901effd4a44186a",
"sha256": "b72c420cac5c74c015f70a7468c1cadfebd73982f864485fa853a76737def893"
},
"downloads": -1,
"filename": "varst-1.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f5f27c169b4763e7f901effd4a44186a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 6639,
"upload_time": "2023-01-12T07:24:57",
"upload_time_iso_8601": "2023-01-12T07:24:57.421138Z",
"url": "https://files.pythonhosted.org/packages/73/cc/155e389978b6e38b612d7d7cfaab7e15c050a258e707889b541a73cb463a/varst-1.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "150b01da2769e5e77e80be1026427f6b6eff6390a1d339d4c290540e0590ff2f",
"md5": "394e010114c7b54ec4dffbf7db421deb",
"sha256": "5c50b64d9dbee84b227ce10ecf4719fe40fb3e38b238b461b92e913204660a8f"
},
"downloads": -1,
"filename": "varst-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "394e010114c7b54ec4dffbf7db421deb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 5344,
"upload_time": "2023-01-12T07:24:58",
"upload_time_iso_8601": "2023-01-12T07:24:58.612560Z",
"url": "https://files.pythonhosted.org/packages/15/0b/01da2769e5e77e80be1026427f6b6eff6390a1d339d4c290540e0590ff2f/varst-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-12 07:24:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "junghoon-vans",
"github_project": "varst",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "varst"
}
JSON
