{ "info": { "author": "Yorick Brunet", "author_email": "mynotes@yok.ch", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7", "Topic :: Utilities" ], "description": "..\n mynotes builds indexes and converts to HTML a tree of notes written in\n Markdown.\n Copyright (C) 2018 Yorick Brunet \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see .\n\nWelcome to *mynotes* !\n======================\n\n*mynotes* builds indexes and converts to HTML a tree of notes written in\nMarkdown.\n\nThe index building phase creates new index files (still in Markdown)\nthat contains links to files and subfolders of the local folder.\n\nAs example, index files for the tree\n\n* A/\n * a1.md\n * a2.md\n* B/\n * BB/\n * bb1.md\n * b1.md\n* c.md\n\nare generated as following\n\n* A/\n * index.md (with links to a1.md and a2.md)\n * a1.md\n * a2.md\n* B/\n * index.md (with links to BB/index.md and b1.md)\n * BB/\n * index.md (with link to bb1.md)\n * bb1.md\n * b1.md\n* c.md\n* index.md (with links to A/index.md, B/index.md and c.md)\n\nThe html generation phase creates HTML files from Markdown files (including\nToC and links to upper/top index).\n\nAdditional files that are not strictly part of the notes (thus files not with\nMarkdown format) can be placed in folders ``_files``. These folders are by\ndefault ignored when building the indexes and generating HTML files.\n\nInstallation\n------------\n\nPython 3.6+ is required to run *mynotes*.\n\nThe package can be installed directly from PyPi using pip:\n\n.. code-block:: shell\n\n pip install mynotes\n\nor downloaded from the release/tags page and then installed using pip:\n\n.. code-block:: shell\n\n pip install mynotes-xxx.tar.gz\n\nExcecution\n----------\n\n*mynotes* package contains two scripts for command line interaction.\n\n* ``mynotes-build`` builds the index files.\n\n.. code-block:: python\n\n usage: mynotes-build [-h] [--verbose] [--config CONFIG]\n\n Build index files for notes tree.\n\n optional arguments:\n -h, --help show this help message and exit\n --verbose, -v Increase verbosity\n --config CONFIG, -c CONFIG\n Configuration file\n\n* ``mynotes-genhtml`` generates HTML files into a dedicated folder.\n\n.. code-block:: python\n\n usage: mynotes-genhtml [-h] [--verbose] [--config CONFIG]\n\n Generate HTML files for markdown files.\n\n optional arguments:\n -h, --help show this help message and exit\n --verbose, -v Increase verbosity\n --config CONFIG, -c CONFIG\n Configuration file\n\nConfiguration\n-------------\n\n*mynotes* writes the its configuration in a configuration file\n(``.mynotes.ini``). This file is created automatically if it does not exist\nand default configuration values are used.\n\n*mynotes* takes only into account section ``[mynotes]`` thus the configuration\ncould be written in common file, e.g. ``setup.cfg``.\n\nThe configuration keys are:\n\n+------------------+----------------------------------------------------------+\n| Key | Purpose |\n+==================+==========================================================+\n| ``index`` | Name of index files (with markdown extension) |\n+------------------+----------------------------------------------------------+\n| ``home`` | Main file of a directory (comes on top of the index list |\n| | and is included in index HTML files. |\n+------------------+----------------------------------------------------------+\n| ``excl_dirs`` | Directories to exclude, independent from path. |\n+------------------+----------------------------------------------------------+\n| ``excl_files`` | Files to exclude, independent from path. The index file |\n| | is not ignore when generating HTML files. |\n+------------------+----------------------------------------------------------+\n| ``md_ext`` | Extension for Markdown files, must be used for ``index`` |\n| | and ``home`` keys. |\n+------------------+----------------------------------------------------------+\n| ``plugins_html`` | Activated plugins for HTML generation: |\n| | |\n| | * ``links-index``: Generate links to upper/top index |\n| | * ``toc``: Generate toc |\n+------------------+----------------------------------------------------------+\n\nExample of configuration file:\n\n.. code-block:: text\n\n [mynotes]\n index = index.md\n home = home.md\n excl_dirs = .git _files _html\n excl_files = .gitignore .python-version index.md Makefile .mynotes.ini\n md_ext = .md\n plugins_html = links-index toc\n\nLicense\n--------\n\n*mynotes* is licensed under the `GNU General Public License version 3\n`_.\n\nSee `LICENSE `_.\n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://gitlab.com/yorickbrunet/mynotes", "keywords": "", "license": "GPL version 3 or later", "maintainer": "", "maintainer_email": "", "name": "mynotes", "package_url": "https://pypi.org/project/mynotes/", "platform": "", "project_url": "https://pypi.org/project/mynotes/", "project_urls": { "Homepage": "https://gitlab.com/yorickbrunet/mynotes" }, "release_url": "https://pypi.org/project/mynotes/1.0.1/", "requires_dist": [ "py-gfm", "Pygments" ], "requires_python": ">= 3.7", "summary": "Build index and generate HTML for markdown notes", "version": "1.0.1" }, "last_serial": 4763779, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "7ddca24a82d0fe0449fc000d046717f0", "sha256": "bd6f991d5d094dc49296e6ec6524f816500510dc3d4ba9aa620bfa57d721e1b1" }, "downloads": -1, "filename": "mynotes-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "7ddca24a82d0fe0449fc000d046717f0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 32060, "upload_time": "2018-11-13T08:02:34", "url": "https://files.pythonhosted.org/packages/4e/d3/0a9aaa8bd00a5d423c32564e5caefa38316061b11363b48a0a88a1936ccd/mynotes-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "394bf8438a3c030840196abbb4f5fab2", "sha256": "49b581029db3f2cd27a0973cf476d40169baf0655c0d0b665353e3d399dd3336" }, "downloads": -1, "filename": "mynotes-1.0.tar.gz", "has_sig": false, "md5_digest": "394bf8438a3c030840196abbb4f5fab2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26831, "upload_time": "2018-11-13T08:02:36", "url": "https://files.pythonhosted.org/packages/38/8e/dc2e763f51a45331799e08b725919a3d316f0f86f90f631211991270b212/mynotes-1.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "918559c1d4483543cff12aba8dc8d93d", "sha256": "63ba2ec8130be43fecf5f618d2a94162b09122fc93e2f37e7a4ecfbda8838122" }, "downloads": -1, "filename": "mynotes-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "918559c1d4483543cff12aba8dc8d93d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">= 3.7", "size": 32263, "upload_time": "2019-01-31T13:46:48", "url": "https://files.pythonhosted.org/packages/f6/4d/a9a976bdc5e0e2af3d1111d74ee23f920220d6d3ee5a05ca499f41bf29ce/mynotes-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d313bb16bcb56f71d41f3eedec2ed4b1", "sha256": "1cb9b3ee0fe7d87694ff704cf30db71db3b0af861bb26a3c49bde8ee97664900" }, "downloads": -1, "filename": "mynotes-1.0.1.tar.gz", "has_sig": false, "md5_digest": "d313bb16bcb56f71d41f3eedec2ed4b1", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.7", "size": 27048, "upload_time": "2019-01-31T13:46:49", "url": "https://files.pythonhosted.org/packages/09/1b/10487bd016ff8e08e612e754523d2b7e9b646534d6e80d23c71c50ffd7e7/mynotes-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "918559c1d4483543cff12aba8dc8d93d", "sha256": "63ba2ec8130be43fecf5f618d2a94162b09122fc93e2f37e7a4ecfbda8838122" }, "downloads": -1, "filename": "mynotes-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "918559c1d4483543cff12aba8dc8d93d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">= 3.7", "size": 32263, "upload_time": "2019-01-31T13:46:48", "url": "https://files.pythonhosted.org/packages/f6/4d/a9a976bdc5e0e2af3d1111d74ee23f920220d6d3ee5a05ca499f41bf29ce/mynotes-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d313bb16bcb56f71d41f3eedec2ed4b1", "sha256": "1cb9b3ee0fe7d87694ff704cf30db71db3b0af861bb26a3c49bde8ee97664900" }, "downloads": -1, "filename": "mynotes-1.0.1.tar.gz", "has_sig": false, "md5_digest": "d313bb16bcb56f71d41f3eedec2ed4b1", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.7", "size": 27048, "upload_time": "2019-01-31T13:46:49", "url": "https://files.pythonhosted.org/packages/09/1b/10487bd016ff8e08e612e754523d2b7e9b646534d6e80d23c71c50ffd7e7/mynotes-1.0.1.tar.gz" } ] }