<p align="center">
<a href="https://github.com/showyourwork/showyourwork">
<img width = "450" src="https://raw.githubusercontent.com/showyourwork/.github/main/images/showyourwork.png" alt="showyourwork"/>
</a>
<br/>
<a href="https://github.com/showyourwork/showyourwork/actions/workflows/tests.yml">
<img src="https://github.com/showyourwork/showyourwork/actions/workflows/unit_tests.yml/badge.svg" alt="unit tests"/>
</a>
<a href="https://github.com/showyourwork/showyourwork/actions/workflows/local_integration_tests.yml">
<img src="https://github.com/showyourwork/showyourwork/actions/workflows/local_integration_tests.yml/badge.svg" alt="local integration tests"/>
</a>
<a href="https://github.com/showyourwork/showyourwork/actions/workflows/remote_integration_tests.yml">
<img src="https://github.com/showyourwork/showyourwork/actions/workflows/remote_integration_tests.yml/badge.svg" alt="remote integration tests"/>
</a>
<a href="https://showyourwork.readthedocs.io">
<img src="https://img.shields.io/static/v1?label=read&message=the%20docs&color=blue" alt="tests"/>
</a>
<a href="https://github.com/showyourwork/showyourwork-action/network/dependents">
<img src="https://img.shields.io/static/v1?label=sample&message=projects&color=green" alt="sample projects"/>
</a>
<a href="https://pypi.org/project/showyourwork/">
<img src="https://img.shields.io/pypi/v/showyourwork" alt="pypi"/>
</a>
</p>
Welcome to `showyourwork!`, a workflow management tool for open source scientific articles. If you want to make your research article **reproducible**, **extensible**, **transparent**, or **just downright awesome**, you’ve found the right tool. `showyourwork!` automates your entire workflow, packaging it into a self-contained recipe that anyone can follow and—at the click of a button—use to reproduce your results.
Please check out the [documentation](https://showyourwork.readthedocs.io) for more information about this project. The [quickstart tutorial](https://showyourwork.readthedocs.io/en/latest/quickstart) should get you up and running fairly quickly with a simple workflow. Dig deeper by reading about the [command line interface](https://showyourwork.readthedocs.io/en/latest/cli), the [recommended project layout](https://showyourwork.readthedocs.io/en/latest/layout), the workflow [configuration file](https://showyourwork.readthedocs.io/en/latest/config), and details about the [integration with LaTeX](https://showyourwork.readthedocs.io/en/latest/latex). You can also check out a list of example projects that use `showyourwork!` [here](https://showyourwork.readthedocs.io/en/latest/projects).
`showyourwork!` is a work in progress, so please look over the [issues page](https://github.com/showyourwork/showyourwork/issues) if you think you’ve spotted a bug, and feel free to [raise a new issue](https://github.com/showyourwork/showyourwork/issues/new) if needed! Community contributions are also most welcome. Make sure to check out our new [discussion board](https://github.com/showyourwork/showyourwork/discussions)!
Raw data
{
"_id": null,
"home_page": "https://github.com/showyourwork/showyourwork",
"name": "showyourwork",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Rodrigo Luger",
"author_email": "rodluger@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fa/ca/227ca1f47e0a6de7e14fc5a67b3c9b9ac80166a6dea32ca607198004e512/showyourwork-0.4.3.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://github.com/showyourwork/showyourwork\">\n <img width = \"450\" src=\"https://raw.githubusercontent.com/showyourwork/.github/main/images/showyourwork.png\" alt=\"showyourwork\"/>\n </a>\n <br/>\n <a href=\"https://github.com/showyourwork/showyourwork/actions/workflows/tests.yml\">\n <img src=\"https://github.com/showyourwork/showyourwork/actions/workflows/unit_tests.yml/badge.svg\" alt=\"unit tests\"/>\n </a>\n <a href=\"https://github.com/showyourwork/showyourwork/actions/workflows/local_integration_tests.yml\">\n <img src=\"https://github.com/showyourwork/showyourwork/actions/workflows/local_integration_tests.yml/badge.svg\" alt=\"local integration tests\"/>\n </a>\n <a href=\"https://github.com/showyourwork/showyourwork/actions/workflows/remote_integration_tests.yml\">\n <img src=\"https://github.com/showyourwork/showyourwork/actions/workflows/remote_integration_tests.yml/badge.svg\" alt=\"remote integration tests\"/>\n </a>\n <a href=\"https://showyourwork.readthedocs.io\">\n <img src=\"https://img.shields.io/static/v1?label=read&message=the%20docs&color=blue\" alt=\"tests\"/>\n </a>\n <a href=\"https://github.com/showyourwork/showyourwork-action/network/dependents\">\n <img src=\"https://img.shields.io/static/v1?label=sample&message=projects&color=green\" alt=\"sample projects\"/>\n </a>\n <a href=\"https://pypi.org/project/showyourwork/\">\n <img src=\"https://img.shields.io/pypi/v/showyourwork\" alt=\"pypi\"/>\n </a>\n</p>\n\nWelcome to `showyourwork!`, a workflow management tool for open source scientific articles. If you want to make your research article **reproducible**, **extensible**, **transparent**, or **just downright awesome**, you\u2019ve found the right tool. `showyourwork!` automates your entire workflow, packaging it into a self-contained recipe that anyone can follow and\u2014at the click of a button\u2014use to reproduce your results.\n\nPlease check out the [documentation](https://showyourwork.readthedocs.io) for more information about this project. The [quickstart tutorial](https://showyourwork.readthedocs.io/en/latest/quickstart) should get you up and running fairly quickly with a simple workflow. Dig deeper by reading about the [command line interface](https://showyourwork.readthedocs.io/en/latest/cli), the [recommended project layout](https://showyourwork.readthedocs.io/en/latest/layout), the workflow [configuration file](https://showyourwork.readthedocs.io/en/latest/config), and details about the [integration with LaTeX](https://showyourwork.readthedocs.io/en/latest/latex). You can also check out a list of example projects that use `showyourwork!` [here](https://showyourwork.readthedocs.io/en/latest/projects).\n\n`showyourwork!` is a work in progress, so please look over the [issues page](https://github.com/showyourwork/showyourwork/issues) if you think you\u2019ve spotted a bug, and feel free to [raise a new issue](https://github.com/showyourwork/showyourwork/issues/new) if needed! Community contributions are also most welcome. Make sure to check out our new [discussion board](https://github.com/showyourwork/showyourwork/discussions)!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A workflow for open-source scientific articles",
"version": "0.4.3",
"project_urls": {
"Homepage": "https://github.com/showyourwork/showyourwork"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bb9693f845c7ce3af9322dbdc7b7ec11bc754352fcad7cdf8c9e2a1f26f9f54e",
"md5": "142dbd64564aec2d38e5e6b6207bc991",
"sha256": "1f9b2e014afba5feb89283d61cb71044bc3ca76d3caa26d0ee4a267a75156730"
},
"downloads": -1,
"filename": "showyourwork-0.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "142dbd64564aec2d38e5e6b6207bc991",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2729422,
"upload_time": "2023-08-03T12:10:48",
"upload_time_iso_8601": "2023-08-03T12:10:48.912876Z",
"url": "https://files.pythonhosted.org/packages/bb/96/93f845c7ce3af9322dbdc7b7ec11bc754352fcad7cdf8c9e2a1f26f9f54e/showyourwork-0.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "faca227ca1f47e0a6de7e14fc5a67b3c9b9ac80166a6dea32ca607198004e512",
"md5": "b5cfb8bd405c0cceb1784722628b3ecb",
"sha256": "584884868a19355e3ba5a9e103fc6bb11d7bf4483cf4dae8ec5cacb0c761fdc8"
},
"downloads": -1,
"filename": "showyourwork-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "b5cfb8bd405c0cceb1784722628b3ecb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2699497,
"upload_time": "2023-08-03T12:10:53",
"upload_time_iso_8601": "2023-08-03T12:10:53.892892Z",
"url": "https://files.pythonhosted.org/packages/fa/ca/227ca1f47e0a6de7e14fc5a67b3c9b9ac80166a6dea32ca607198004e512/showyourwork-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-03 12:10:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "showyourwork",
"github_project": "showyourwork",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "showyourwork"
}
JSON
