{ "info": { "author": "Simon Lars\u00e9n", "author_email": "slarse@kth.se", "bugtrack_url": null, "classifiers": [], "description": "browser-markdown-editor - A barebones Markdown editor for web browsers\n**********************************************************************\n\n`Docs`_\n\n.. image:: https://travis-ci.org/slarse/browser-markdown-editor.svg?branch=master\n :target: https://travis-ci.org/slarse/browser-markdown-editor\n :alt: Build Status\n.. image:: https://codecov.io/gh/slarse/browser-markdown-editor/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/slarse/browser-markdown-editor\n :alt: Code Coverage\n.. image:: https://readthedocs.org/projects/browser-markdown-editor/badge/?version=latest\n :target: http://browser-markdown-editor.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. image:: https://badge.fury.io/py/browser-markdown-editor.svg\n :target: https://badge.fury.io/py/browser-markdown-editor\n :alt: PyPi Version\n.. image:: https://img.shields.io/badge/python-3.6-blue.svg\n :target: https://badge.fury.io/py/pdfebc\n :alt: Supported Python Versions\n\n.. contents::\n\nOverview\n========\nThe Browser Markdown Editor is a supremely simple Markdown editor that displays\nedits in real time. It is a very simple project built with ``Flask``, and the\nMarkdown functionality is implemented with `Flask-PageDown`_. \nApart from simply editing Markdown, you may also upload ``.md`` files for editing,\nas well as download the file that is currently being edited.\n\nRequirements\n============\nApart from the requirements listed in `requirements.txt`_, you will also need\na web browser of your choice and ``Python 3.6`` or higher.\n\nFeatures\n========\n\nEdit Markdown and see results in real time\n------------------------------------------\n.. image:: images/edit.gif\n :alt: Editing a Markdown source file.\n\nDownload the file being edited\n------------------------------\n.. image:: images/download.gif\n :alt: Downloading a Markdown source file.\n\nUpload ``.md`` files for editing\n--------------------------------\n.. image:: images/upload.gif\n :alt: Uploading a Markdown source file.\n\nInstall\n=======\nOption 1: Install from PyPi with ``pip``\n----------------------------------------\nThe latest release of ``browser-markdown-editor`` is on PyPi, and can thus be installed as usual with ``pip``.\nI strongly discourage system-wide ``pip`` installs (i.e. ``sudo pip install ``), as this\nmay land you with incompatible packages in a very short amount of time. A per-user install\ncan be done like this:\n\n1. Execute ``pip install --user browser-markdown-editor`` to install the package.\n2. Verify the installation by typing ``browser-markdown-editor`` on the command line.\n It should give you some usage options.\n3. If step 2 fails, it is probably because ``$HOME/.local/bin`` is not on your ``PATH`` variable.\n Add it for the current session by executing ``export PATH=\"$PATH:$HOME/.local/bin\"``. Add that\n line to your ``.bashrc`` (or equivalent) for this to happen automagically when starting a shell.\n\nOption 2: Clone the repo and the install with ``pip``\n-----------------------------------------------------\nIf you want the dev version, you will need to clone the repo, as only release versions are uploaded\nto PyPi. Unless you are planning to work on this yourself, I suggest going with the release version.\n\n1. Clone the repo with ``git``:\n - ``git clone https://github.com/slarse/browser-markdown-editor``\n2. ``cd`` into the project root directory and install with ``pip``.\n - ``pip install --user .``, this will create a local install for the current user.\n - Or just ``pip install .`` if you use ``virtualenv``.\n - For development, use ``pip install -e .`` in a ``virtualenv``.\n3. Verify the installation by typing ``browser-markdown-editor`` on the command line.\n It should give you some usage options.\n4. If step 3 fails, it is probably because ``$HOME/.local/bin`` is not on your ``PATH`` variable.\n Add it for the current session by executing ``export PATH=\"$PATH:$HOME/.local/bin\"``. Add that\n line to your ``.bashrc`` (or equivalent) for this to happen automagically when starting a shell.\n\nHow to run\n==========\nTo start the server, follow the install instructions and then execute \n``browser-markdown-editor runserver``. The host ip will default to\n``127.0.0.1`` and port to ``5000``. These can be specified by providing\n``-h x.x.x.x`` and ``-p n`` options, where ``x.x.x.x`` is the host ip and\n``n`` is the port to listen to.\n\nLicense\n=======\nThis software is licensed under the MIT License. See the `license file`_ file for specifics.\n\nContributing\n============\nIf you feel like you have something meaningful to contribute, by all means, fork the project\nand open a pull request.\n\n.. _license file: LICENSE\n.. _requirements.txt: requirements.txt\n.. _Flask-PageDown: https://github.com/miguelgrinberg/Flask-PageDown\n.. _Docs: http://browser-markdown-editor.readthedocs.io/en/latest/?badge=latest\n\n", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/slarse/browser-markdown-editor/archive/v0.2.0.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/slarse/pdfebc-web", "keywords": "", "license": "MIT License\n\nCopyright (c) 2017 Simon Lars\u00e9n\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", "maintainer": "", "maintainer_email": "", "name": "browser-markdown-editor", "package_url": "https://pypi.org/project/browser-markdown-editor/", "platform": "", "project_url": "https://pypi.org/project/browser-markdown-editor/", "project_urls": { "Download": "https://github.com/slarse/browser-markdown-editor/archive/v0.2.0.tar.gz", "Homepage": "https://github.com/slarse/pdfebc-web" }, "release_url": "https://pypi.org/project/browser-markdown-editor/0.2.0/", "requires_dist": null, "requires_python": "", "summary": "Markdown editor for web browsers, built with Flask.", "version": "0.2.0" }, "last_serial": 3006590, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "86f2c1c35882a06afc9115b85e7c627b", "sha256": "f81a6bf0b8c0a7671ecf87f02496fea53112301b3b440579123616e83f20c764" }, "downloads": -1, "filename": "browser-markdown-editor-0.1.0.tar.gz", "has_sig": false, "md5_digest": "86f2c1c35882a06afc9115b85e7c627b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 50798, "upload_time": "2017-07-06T15:33:02", "url": "https://files.pythonhosted.org/packages/32/12/ee986f7426fea40b1776302731fe865848d89a56d3422871aabe8ebecb37/browser-markdown-editor-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "b61d689c2b6da1d82853aca2e6eee904", "sha256": "a590bb1ffade9e7a381a0f167218e51e470f6a55532a0fb5c435ed9628d629f5" }, "downloads": -1, "filename": "browser-markdown-editor-0.1.1.tar.gz", "has_sig": false, "md5_digest": "b61d689c2b6da1d82853aca2e6eee904", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 50863, "upload_time": "2017-07-06T18:59:46", "url": "https://files.pythonhosted.org/packages/8d/b0/a766b652dd07a7ede275ba0d57c6e2b1cfc347d04c3d4ede3473c964f908/browser-markdown-editor-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "86afaab7e024f38f8545a6d30337ebac", "sha256": "f896696731c3d3667d33279ef81c8ddc00cc69fe53f376907c9a27179e11a7f2" }, "downloads": -1, "filename": "browser-markdown-editor-0.1.2.tar.gz", "has_sig": false, "md5_digest": "86afaab7e024f38f8545a6d30337ebac", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 52253, "upload_time": "2017-07-07T11:33:29", "url": "https://files.pythonhosted.org/packages/62/15/27c8a1b6ff1d0df8ffb9ff6a64a23e456e282cb1b7a04a0ec7e583086d0f/browser-markdown-editor-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "ea5d5ad19bbacdb8fd9ae09b6531a692", "sha256": "1202e4534254b19577d671252369303034f01f0594a22138cc5438eaa39ee146" }, "downloads": -1, "filename": "browser-markdown-editor-0.1.3.tar.gz", "has_sig": false, "md5_digest": "ea5d5ad19bbacdb8fd9ae09b6531a692", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 52261, "upload_time": "2017-07-07T11:41:38", "url": "https://files.pythonhosted.org/packages/64/f1/8b8fcb0807cbb571db34929b31196431373050c9d1761819dfe0e8eaaa95/browser-markdown-editor-0.1.3.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "ce417863cae9e62ecd1e66cf0619f512", "sha256": "d97d25dc6cba4e391e19153ef17a2a3f9a9a85c1f622751065046a882926665e" }, "downloads": -1, "filename": "browser-markdown-editor-0.2.0.tar.gz", "has_sig": false, "md5_digest": "ce417863cae9e62ecd1e66cf0619f512", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1890914, "upload_time": "2017-07-07T16:13:59", "url": "https://files.pythonhosted.org/packages/7e/b3/8ff06977dbb86bbb958e43463a14f67e8ba47c007e06aeb0fbca99f6dde1/browser-markdown-editor-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ce417863cae9e62ecd1e66cf0619f512", "sha256": "d97d25dc6cba4e391e19153ef17a2a3f9a9a85c1f622751065046a882926665e" }, "downloads": -1, "filename": "browser-markdown-editor-0.2.0.tar.gz", "has_sig": false, "md5_digest": "ce417863cae9e62ecd1e66cf0619f512", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1890914, "upload_time": "2017-07-07T16:13:59", "url": "https://files.pythonhosted.org/packages/7e/b3/8ff06977dbb86bbb958e43463a14f67e8ba47c007e06aeb0fbca99f6dde1/browser-markdown-editor-0.2.0.tar.gz" } ] }