{ "info": { "author": "Allegro.ai", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: Apache Software License", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Scientific/Engineering :: Artificial Intelligence", "Topic :: Software Development", "Topic :: Software Development :: Version Control", "Topic :: System :: Logging", "Topic :: System :: Monitoring" ], "description": "# [TRAINS](https://github.com/allegroai/trains) Jupyter Plugin\n\ntrains-jupyter-plugin is a jupyter notebook extension enabling users to push ipython notebooks to git repository.\nThe git [button](#Screenshots) is displayed in the notebook toolbar. After saving any notebook\nthe user can push notebook to pre-specified git repository.\nCurrently this extension supports commits to a pre initialized git repository and pre-defined branch.\nThe notebook will be pushed to the git repository, based on the folder structure it is located in.\nThe notebook will also be converted to `.py` script and pushed together with the `.ipynb`.\nAdditionally, a `requirements.txt` will be created and updated according to the notebook imports. \nThe requirements file will also be pushed to the git.\n\n\nExamples of two repositories: \"notebook1.ipynb\" will be pushed to \"repo1\" and \"notebook2.ipynb\" to \"repo2\":\n```\nrepo1/\n\u251c\u2500\u2500 .git\n\u2514\u2500\u2500 experiment1/\n \u2514\u2500\u2500 notebook.ipynb\n\nrepo2/\n\u251c\u2500\u2500 .git\n\u2514\u2500\u2500 experiment2/\n \u2514\u2500\u2500 notebook2.ipynb\n```\n\n\nSelection of a specific branch is done using git checkout from the jupyter host machine.\nFor example, switch to branch2 in repo2:\n```\n$ cd ~/repo2\n$ git checkout branch2\n```\nFrom this point onwards the jupyter notebook push will be done to \"branch2\"\n\n\n## Installation\n\nYou can install directly from pypi:\n\n```\npip install trains-jupyter-plugin\n\nif [ ! -f ~/.jupyter/jupyter_notebook_config.py ]; then\n jupyter notebook --generate-config\nfi\necho 'c.NotebookApp.disable_check_xsrf = True' >> ~/.jupyter/jupyter_notebook_config.py\n\njupyter serverextension enable --py trains-jupyter-plugin\nsudo jupyter nbextension install --py trains-jupyter-plugin\n```\n\nTo enable the extension for all notebooks:\n\n```\njupyter nbextension enable --py trains-jupyter-plugin\n```\n\n## Steps\n\n* Install package using above commands\n* Clone your Git repository to a folder that will be assigned to a specific user \n* Checkout a specific branch for the current user\n* Make sure git is configured with the correct credentials \n(it is advised to verify there is need to for password/passphrase when pushing)\n* Run jupyter notebook \n* Any commit/push of notebooks from this specific folder will be done to the selected branch\n\n## Screenshots\n\n![Extension](docs/extension.png?raw=true \"Extension added to toolbar\")\n\n![Commit Message](docs/commit.png?raw=true \"Commit Message\")\n\n![Success Message](docs/success.png?raw=true \"Success Message\")\n\n## Credits\n\nThanks to https://github.com/Lab41/sunny-side-up & https://github.com/sat28/githubcommit for laying the foundation of this extension.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/allegroai/trains-jupyter-plugin", "keywords": "trains jupyer notebook development machine deep learning version control machine-learning machinelearning deeplearning deep-learning experiment-manager experimentmanager", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "trains-jupyter-plugin", "package_url": "https://pypi.org/project/trains-jupyter-plugin/", "platform": "", "project_url": "https://pypi.org/project/trains-jupyter-plugin/", "project_urls": { "Homepage": "https://github.com/allegroai/trains-jupyter-plugin" }, "release_url": "https://pypi.org/project/trains-jupyter-plugin/0.2.0/", "requires_dist": [ "notebook", "pathlib2", "pigar", "psutil" ], "requires_python": "", "summary": "Jupyter extension to enable users to commit & push notebooks to a git repo", "version": "0.2.0" }, "last_serial": 5383681, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "c7eb6b3de3e9309cc9d37bc0df63e7f2", "sha256": "4f1a2814004ab714d6b3da7c1c3eef467486e31b7a25bdb4c4e50cc1cf4c271c" }, "downloads": -1, "filename": "trains_jupyter_plugin-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c7eb6b3de3e9309cc9d37bc0df63e7f2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 35291, "upload_time": "2019-06-10T22:27:18", "url": "https://files.pythonhosted.org/packages/b0/45/efbd6119b96649ead65f4a5616820f65f67719c6083e854cd6277435e320/trains_jupyter_plugin-0.2.0-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c7eb6b3de3e9309cc9d37bc0df63e7f2", "sha256": "4f1a2814004ab714d6b3da7c1c3eef467486e31b7a25bdb4c4e50cc1cf4c271c" }, "downloads": -1, "filename": "trains_jupyter_plugin-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c7eb6b3de3e9309cc9d37bc0df63e7f2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 35291, "upload_time": "2019-06-10T22:27:18", "url": "https://files.pythonhosted.org/packages/b0/45/efbd6119b96649ead65f4a5616820f65f67719c6083e854cd6277435e320/trains_jupyter_plugin-0.2.0-py2.py3-none-any.whl" } ] }