{ "info": { "author": "Blaine Murphy", "author_email": "myself@blaines.world", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Topic :: Internet :: WWW/HTTP :: Site Management" ], "description": "Chanterelle\n===========\nChanterelle is a command line utility written in Python 3 that synchronizes\nthe contents of an S3 bucket with a local static website. This tool has no\ndependency on Jekyll or Ruby, but assumes a default configuration that works\nwith the default structure of a Jekyll site.\n\nChanterelle was designed to reduce the monetary cost of using the S3 API by\nonly making changes that are necessary to a bucket. Files are not uploaded if\nalready present in the bucket with the same content, and bulk list and delete\noperations are used.\n\n\nInstallation\n------------\nTo install with Chanterelle you will need `Python 3 `_\nand `setuptools `_. Run the following to install the\nlatest release of Chanterelle directly from PyPI:\n\n.. code-block:: console\n\n $ pip install chanterelle\n\n\nConfiguration\n-------------\nChanterelle can be configured using a YAML file placed in the project root\ncalled :code:`_upload.yml`. Jekyll's :code:`_config.yml` is not read by\nChanterelle. The following is a table of keys for the configuration file:\n\n+------------+----------------------------------------------------------------+\n| Key | Description |\n+============+================================================================+\n| bucket | Name of the S3 bucket to synchronize. This key is required. |\n+------------+----------------------------------------------------------------+\n| profile | Name of the `AWS profile `_ to use. |\n| | The default profile will be used if omitted. |\n+------------+----------------------------------------------------------------+\n| site_root | Path to the root of the generated site. Default value is |\n| | :code:`_site`. |\n+------------+----------------------------------------------------------------+\n| mime_types | Map of file extension (including dot) to mime-type that will |\n| | be in addition to the system's map to determine the |\n| | Content-Type of a file. |\n+------------+----------------------------------------------------------------+\n| charset | Content-Type charset assigned to files that are subtypes of |\n| | the :code:`text` type (:code:`text/*`). Default value is |\n| | :code:`utf-8`. |\n+------------+----------------------------------------------------------------+\n| strip_html | If set to :code:`true` the :code:`.html` extension will be |\n| | stripped from the filenames of uploaded files. This is useful |\n| | for permalink styles that dont include an extension. Default |\n| | value is :code:`false`. |\n+------------+----------------------------------------------------------------+\n| delete_old | If set to :code:`true` files in the bucket that do not exist |\n| | in the local directory will be deleted. Default value is |\n| | :code:`false`. |\n+------------+----------------------------------------------------------------+\n\nAWS Credentials\n~~~~~~~~~~~~~~~\nIn addition to :code:`_upload.yml` you will also need to configure AWS\ncredentials. These are ommited from :code:`_upload.yml` so it can be checked\ninto version control without sharing keys with contributors.\n\nThere are several ways to `manually configure `_ the credentials that Chanterelle\nuses, but the easiest way for those only using a single set of credentials is\nto use the `configure command `_ of\nthe `aws command line tool `_:\n\n.. code-block:: console\n\n $ aws configure\n\n\nUsage\n-----\nOnce you have created :code:`_upload.yml` and set AWS credentials, you can run\nChanterelle from the command line:\n\n.. code-block:: console\n\n $ chanterelle\n\n\nLicensing\n---------\nChanterelle is licensed under the GNU General Public License v3.0 (GNU GPLv3),\nsee `LICENSE` for details.\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://gitlab.com/unixispower/chanterelle", "keywords": "", "license": "GPLv3", "maintainer": "", "maintainer_email": "", "name": "chanterelle", "package_url": "https://pypi.org/project/chanterelle/", "platform": "", "project_url": "https://pypi.org/project/chanterelle/", "project_urls": { "Homepage": "https://gitlab.com/unixispower/chanterelle" }, "release_url": "https://pypi.org/project/chanterelle/1.0.2/", "requires_dist": null, "requires_python": "", "summary": "Utility for uploading static site files to an S3 bucket", "version": "1.0.2" }, "last_serial": 5114722, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "c27a0e09180a12163c187a27e12c2c58", "sha256": "ac1183ae8702eb5f071b86ae227b66c48d8c1c6b14ce373f1836ffe362d2754b" }, "downloads": -1, "filename": "chanterelle-0.1.0.tar.gz", "has_sig": false, "md5_digest": "c27a0e09180a12163c187a27e12c2c58", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5875, "upload_time": "2017-07-13T23:02:07", "url": "https://files.pythonhosted.org/packages/82/33/1be8eff7a393c799b7b4f3b8762343e8fb5655db6c32cd59d944cf9f2cc5/chanterelle-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "91f10c5c767ca8df11e4e7a0c67bb4e4", "sha256": "a728eabb15ce74d59b1989a0358ed5b054657c1acc27e00ba21b1af3ffc80a6d" }, "downloads": -1, "filename": "chanterelle-0.2.0.tar.gz", "has_sig": false, "md5_digest": "91f10c5c767ca8df11e4e7a0c67bb4e4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5147, "upload_time": "2017-08-03T02:56:59", "url": "https://files.pythonhosted.org/packages/30/2e/738c17fcef247307b62b1a1e084ae880166151109e6c981934cbab5952e5/chanterelle-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "9529a0f729dce0e6601a9b178982cedc", "sha256": "b33239b3f668646c8434571406e0eab0df557e33ccde941df0b873bc7c5a7419" }, "downloads": -1, "filename": "chanterelle-0.2.1.tar.gz", "has_sig": false, "md5_digest": "9529a0f729dce0e6601a9b178982cedc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5166, "upload_time": "2017-08-03T03:58:13", "url": "https://files.pythonhosted.org/packages/6d/8f/abf00cec873cd6e3e09aaf333332e71956a14ff5fa8b5ae64b961db5fd50/chanterelle-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "2052ca6d18d3d7fff277026a0173a9a6", "sha256": "334798634fa45659e24ceabe0dbc7b8cda71e95a6e4b4e198feb1be5d58ffbf9" }, "downloads": -1, "filename": "chanterelle-0.2.2.tar.gz", "has_sig": false, "md5_digest": "2052ca6d18d3d7fff277026a0173a9a6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5038, "upload_time": "2017-08-06T17:59:15", "url": "https://files.pythonhosted.org/packages/e6/92/378f99b2c4eee931f54caba1c3faa3981b89b5f194af6dd4d1d9d2e23419/chanterelle-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "bd49832b120ae314f6532826cf7a23fe", "sha256": "64384731ac48d4c9baa39e9ee7b711ea1c41256a54ef0acca30ccc5c4ac94298" }, "downloads": -1, "filename": "chanterelle-0.2.3.tar.gz", "has_sig": false, "md5_digest": "bd49832b120ae314f6532826cf7a23fe", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5136, "upload_time": "2017-08-17T04:31:19", "url": "https://files.pythonhosted.org/packages/c4/71/bccf0e09913cc9c285b85bcda84a34518e3389c48bd821a2da63f9804cf0/chanterelle-0.2.3.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "83e8b0817ac33d251f01a89db2dc79bc", "sha256": "20b96c63cd5de4874456aa9a03b70500e47905de623a905625f8104f35ef1ed8" }, "downloads": -1, "filename": "chanterelle-1.0.0.tar.gz", "has_sig": false, "md5_digest": "83e8b0817ac33d251f01a89db2dc79bc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5246, "upload_time": "2017-09-30T22:09:55", "url": "https://files.pythonhosted.org/packages/48/0b/99e208c839f514d3d11131b97a8115e0258b1906dc5d49a070170a845013/chanterelle-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "f1ca5c1ea47980f1f80765b407ded83b", "sha256": "c7497ffdb9df6e3091e9ca487641ae61801a9c36c2dd1b821ecaf6b7f7481579" }, "downloads": -1, "filename": "chanterelle-1.0.1.tar.gz", "has_sig": false, "md5_digest": "f1ca5c1ea47980f1f80765b407ded83b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5303, "upload_time": "2018-06-08T08:02:37", "url": "https://files.pythonhosted.org/packages/6c/2b/c655f69668240d0d53ed92bcbb5d615ee7850c28f5a7f0afd3372b84a407/chanterelle-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "cde3435f9e27b0a15cc5ad126360d67d", "sha256": "4b207d1691b408b85338c2b44872586eaaf5ce64c75a84d1311f9dc4628e75fc" }, "downloads": -1, "filename": "chanterelle-1.0.2.tar.gz", "has_sig": false, "md5_digest": "cde3435f9e27b0a15cc5ad126360d67d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5199, "upload_time": "2018-11-17T07:14:01", "url": "https://files.pythonhosted.org/packages/cd/b3/d156e196d4082ae89d7b07bfacaf61e056d7b45f42ab474c56c91a4c1709/chanterelle-1.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "cde3435f9e27b0a15cc5ad126360d67d", "sha256": "4b207d1691b408b85338c2b44872586eaaf5ce64c75a84d1311f9dc4628e75fc" }, "downloads": -1, "filename": "chanterelle-1.0.2.tar.gz", "has_sig": false, "md5_digest": "cde3435f9e27b0a15cc5ad126360d67d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5199, "upload_time": "2018-11-17T07:14:01", "url": "https://files.pythonhosted.org/packages/cd/b3/d156e196d4082ae89d7b07bfacaf61e056d7b45f42ab474c56c91a4c1709/chanterelle-1.0.2.tar.gz" } ] }