{ "info": { "author": "Russell Smiley", "author_email": "im.russell.smiley@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)" ], "description": "packageManifest\n---------------\n\n|pipeline| |coverage|\n\n.. |pipeline| image:: https://gitlab.com/blueskyjunkie/package-manifest/badges/master/pipeline.svg\n :target: https://gitlab.com/blueskyjunkie/package-manifest/commits/master\n :alt: pipeline status\n\n.. |coverage| image:: https://gitlab.com/blueskyjunkie/package-manifest/badges/master/coverage.svg\n :target: https://gitlab.com/blueskyjunkie/package-manifest/commits/master\n :alt: coverage report\n\n\n|doi0.2.0|\n\n.. |doi0.2.0| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1165137.svg\n :target: https://doi.org/10.5281/zenodo.1165137\n :alt: DOI v0.2.0\n\n\nA Python 3 framework for creating and maintaining a generalised manifest of files inspired by the Python MANIFEST.in. The framework would typically used as the basis of some kind of packaging tool to define the file needed for distribution of the package.\n\n\n.. contents::\n\n.. section-numbering::\n\nMain Features\n=============\n\n* YAML based file format\n* Common manifest operations:\n\n * include/exclude\n * global include/exclude\n * recursive include/exclude\n * prune/graft\n\nInstallation\n============\n\nThe simplest way to acquire ``packageManifest`` is using ``pip``.\n\n.. code-block:: bash\n\n pip install packageManifest\n\nGetting Started\n===============\n\nThe manifest YAML file is simply a list of the include or exclude operations to comprise the formulation of files. There\nare six different types of operations - the same as the Python MANIFEST.in_.\n\n.. _MANIFEST.in: https://docs.python.org/2/distutils/sourcedist.html#manifest-template\n\nEach include/exclude operation can take either a ``files`` directive or a ``directory`` directive, or both, depending\non the type of include/exclude being applied.\n\n.. code-block:: yaml\n\n - include:\n files: [ 'LICENSE', 'README.md' ]\n - exclude:\n files: [ '*.orig' ]\n - recursive-include:\n directory: 'include'\n files: [ '*.h', '*.c' ]\n - recursive-exclude:\n directory: 'temp/subdir'\n files: [ '*' ]\n - global-include:\n files: [ 'Makefile' ]\n - global-exclude:\n files: [ '*.txt', '*.tmp', 'test' ]\n - prune:\n directory: 'bin'\n - graft:\n directory: 'src'\n\nThe ``files`` directive contains a list of unix-glob like patterns to be applied to files.\nThe ``directory`` directive contains a single character string of the directory.\n\nUsing the manifest file is simply a matter of importing the library and using the ``from_yamlFile`` class method to\nimport the operations and apply them to the specified root directory of the directory tree from which to extract files.\n\n.. code-block:: python\n\n from package-manifest import Manifest\n\n thisManifest = Manifest.from_yamlFile( 'manifest.yml', '.' )\n\n manifestFiles = thisManifest.apply()\n\n``manifestFiles`` now contains a Python set of the file names from the root directory ``'.'`` that have been filtered by\nthe operations specified in the file ``manifest.yml``.\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://gitlab.com/blueskyjunkie/package-manifest", "keywords": "manifest package distribution file", "license": "", "maintainer": "", "maintainer_email": "", "name": "packageManifest", "package_url": "https://pypi.org/project/packageManifest/", "platform": "", "project_url": "https://pypi.org/project/packageManifest/", "project_urls": { "Homepage": "https://gitlab.com/blueskyjunkie/package-manifest" }, "release_url": "https://pypi.org/project/packageManifest/0.3.0/", "requires_dist": [ "pyyaml" ], "requires_python": ">=3", "summary": "A YAML based file package-manifest framework for defining packages.", "version": "0.3.0" }, "last_serial": 3553327, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "405a6f669a09d5a419a504e0fdf89131", "sha256": "7c2ef9c7ed22f0e4de9f866fdbe7711a9807d5b4a016fdf2fc615c695f0d7b18" }, "downloads": -1, "filename": "packageManifest-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "405a6f669a09d5a419a504e0fdf89131", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 158687, "upload_time": "2018-02-03T13:11:10", "url": "https://files.pythonhosted.org/packages/03/55/1a31dc8e0637bcef7abb100ad967c04b7050f43e86c1108d1c95c4a8884c/packageManifest-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b9fb609d67205a54d7109fc794ca3515", "sha256": "bd56bb0d547aaf033493af97852a828a73c88f897200032452a8aa24c2e0c402" }, "downloads": -1, "filename": "packageManifest-0.2.0.tar.gz", "has_sig": false, "md5_digest": "b9fb609d67205a54d7109fc794ca3515", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 27324, "upload_time": "2018-02-03T13:11:11", "url": "https://files.pythonhosted.org/packages/c7/2b/630022747d13af76b3ee85856f26981caa722cde2c964fa280369cdf1678/packageManifest-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "8542d2eaa487f939ad0890f4793e38e8", "sha256": "9ed782141c23b8446748c6e5de2dd2cf4d210b8fc283bb3d14acc78a7f3e3075" }, "downloads": -1, "filename": "packageManifest-0.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8542d2eaa487f939ad0890f4793e38e8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 158958, "upload_time": "2018-02-05T13:29:24", "url": "https://files.pythonhosted.org/packages/8c/22/5148f71984693a8c57a80d914f395f6f1e3ef6d36b50a4ea22dd25db88fb/packageManifest-0.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a453ae9a9d495b2ab01116439f8c0a71", "sha256": "77746b8069e03c20edc18c38500ce68fc85613ae3b6b9a6341d7a8e9edc56221" }, "downloads": -1, "filename": "packageManifest-0.3.0.tar.gz", "has_sig": false, "md5_digest": "a453ae9a9d495b2ab01116439f8c0a71", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 27479, "upload_time": "2018-02-05T13:29:26", "url": "https://files.pythonhosted.org/packages/11/23/0336e54bcf9c52062cfbe7aa45fecad78c78a94cfd33bdc068d7b7bca2c6/packageManifest-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8542d2eaa487f939ad0890f4793e38e8", "sha256": "9ed782141c23b8446748c6e5de2dd2cf4d210b8fc283bb3d14acc78a7f3e3075" }, "downloads": -1, "filename": "packageManifest-0.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8542d2eaa487f939ad0890f4793e38e8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 158958, "upload_time": "2018-02-05T13:29:24", "url": "https://files.pythonhosted.org/packages/8c/22/5148f71984693a8c57a80d914f395f6f1e3ef6d36b50a4ea22dd25db88fb/packageManifest-0.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a453ae9a9d495b2ab01116439f8c0a71", "sha256": "77746b8069e03c20edc18c38500ce68fc85613ae3b6b9a6341d7a8e9edc56221" }, "downloads": -1, "filename": "packageManifest-0.3.0.tar.gz", "has_sig": false, "md5_digest": "a453ae9a9d495b2ab01116439f8c0a71", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 27479, "upload_time": "2018-02-05T13:29:26", "url": "https://files.pythonhosted.org/packages/11/23/0336e54bcf9c52062cfbe7aa45fecad78c78a94cfd33bdc068d7b7bca2c6/packageManifest-0.3.0.tar.gz" } ] }