{"id":19082997,"url":"https://github.com/deep5050/autopy-lot","last_synced_at":"2025-04-30T08:48:00.768Z","repository":{"id":53825686,"uuid":"258740319","full_name":"deep5050/autopy-lot","owner":"deep5050","description":"github action to convert jupyter notebooks to various formats","archived":false,"fork":false,"pushed_at":"2020-11-02T16:40:47.000Z","size":822,"stargazers_count":18,"open_issues_count":3,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-18T20:42:10.228Z","etag":null,"topics":["actions","docker","github-actions","jupyter-notebook","markdown","notebook-jupyter","python"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deep5050.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"custom":"paypal.me/deep5050"}},"created_at":"2020-04-25T09:56:45.000Z","updated_at":"2024-08-08T14:43:32.000Z","dependencies_parsed_at":"2023-01-04T12:30:36.137Z","dependency_job_id":null,"html_url":"https://github.com/deep5050/autopy-lot","commit_stats":{"total_commits":47,"total_committers":3,"mean_commits":"15.666666666666666","dds":0.1063829787234043,"last_synced_commit":"cdd4c35e4e195ebd8746e080f39296b0c926ce52"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deep5050%2Fautopy-lot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deep5050%2Fautopy-lot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deep5050%2Fautopy-lot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deep5050%2Fautopy-lot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deep5050","download_url":"https://codeload.github.com/deep5050/autopy-lot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223780084,"owners_count":17201286,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","docker","github-actions","jupyter-notebook","markdown","notebook-jupyter","python"],"created_at":"2024-11-09T02:45:33.847Z","updated_at":"2024-11-09T02:45:34.542Z","avatar_url":"https://github.com/deep5050.png","language":"Jupyter Notebook","funding_links":["paypal.me/deep5050"],"categories":[],"sub_categories":[],"readme":"![autopy-lot](https://socialify.git.ci/deep5050/autopy-lot/image?description=1\u0026descriptionEditable=github%20action%20to%20convert%20jupyter%20notebooks%20to%20various%20formats\u0026font=Source%20Code%20Pro\u0026forks=1\u0026issues=1\u0026logo=https%3A%2F%2Fi.imgur.com%2FWZSNO5m.png\u0026pattern=Signal\u0026pulls=1\u0026stargazers=1\u0026theme=Light)\n\n\n![test-markdown](https://github.com/deep5050/autopy-lot/workflows/test-markdown/badge.svg)\n![test-py](https://github.com/deep5050/autopy-lot/workflows/test-py/badge.svg)\n![vistors](http://hits.dwyl.com/deep5050/autopy-lot.svg)\n\n## conversions:\n1. .ipynb -\u003e .md\n2. .ipynb -\u003e .py   \u003cb\u003e(DEFAULT)\u003c/b\u003e\n3. .py -\u003e .ipynb\n\n### NOTE\n``R`` support will be added soon. Please don't try to convert R files for now.\n\n## USAGE\n\ncreate a ``autopy-lot.yml`` file under ``.github/workflows`` with the following contents:\n### Default configuration\n\n```yaml\nname: autopy-lot\non: [push]\n\njobs:\n  build:\n    name: autopy-lot\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v1\n      - name: autopy-lot \n        uses: deep5050/autopy-lot@master\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN}}\n          output_dir: './autopy-lot/'\n```\n### Advanced configuration\n\n```yaml\nname: autopy-lot\non: [push]\n\njobs:\n  build:\n    name: autopy-lot\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v1\n      - name: autopy-lot \n        uses: deep5050/autopy-lot@master\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN}}\n          check:\n          input_type:\n          comment_magics:\n          split_at_heading:\n          output_type:\n          output_dir: './autopy-lot/'\n\n\n```\n### Input options\n\n``check``  : ``all`` to convert all specified files (based on file type) on every run. ``latest`` to convert only the files changed on last commit.\n\n``input_types`` : ``py`` ``ipynb`` ``r``\n\n``comment_magics`` : ``true`` see jupytext documentation for further details.\n\n``split_at_heading`` : ``true`` see jupytext documentation for further details.\n\n\n``output_type`` : ``py`` ``markdown`` ``r`` ``ipynb``\n\n\n``output_dir``: give a output directory name where all the converted outputs will be stored. default is ``./autopy-lot/``. when provide custom path name, make sure the to put the initial ``.`` and ``/`` at the end. please note that it is a mandatory input argument.\n\n\n## Note\n\nThis action can handle only one type of conversion per workflow setup.\nIf you need to convert input files to different file types, you need to create several ``.yml`` files under ``.github/workflows``.\n\nExample :\n\n``autopy-lot-markdown.yml`` , ``autopy-lot-py.yml``.\n\n## License\n\n\u003eMIT License\n\n\u003eCopyright (c) 2020 Dipankar Pal\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n## Thanks\nIcons made by \u003ca href=\"https://www.flaticon.com/authors/freepik\" title=\"Freepik\"\u003eFreepik\u003c/a\u003e from \u003ca href=\"https://www.flaticon.com/\" title=\"Flaticon\"\u003e www.flaticon.com\u003c/a\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeep5050%2Fautopy-lot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeep5050%2Fautopy-lot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeep5050%2Fautopy-lot/lists"}