{ "info": { "author": "Cloudreach", "author_email": "sceptre@cloudreach.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "Natural Language :: English", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# Sceptre\n\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Sceptre_sceptre-core&metric=bugs)](https://sonarcloud.io/dashboard?id=Sceptre_sceptre-core)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Sceptre_sceptre-core&metric=coverage)](https://sonarcloud.io/dashboard?id=Sceptre_sceptre-core)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Sceptre_sceptre-core&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=Sceptre_sceptre-core)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Sceptre_sceptre-core&metric=alert_status)](https://sonarcloud.io/dashboard?id=Sceptre_sceptre-core)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Sceptre_sceptre-core&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=Sceptre_sceptre-core)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Sceptre_sceptre-core&metric=security_rating)](https://sonarcloud.io/dashboard?id=Sceptre_sceptre-core)\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=Sceptre_sceptre-core&metric=sqale_index)](https://sonarcloud.io/dashboard?id=Sceptre_sceptre-core)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Sceptre_sceptre-core&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=Sceptre_sceptre-core)\n![image](https://circleci.com/gh/Sceptre/sceptre-core.png?style=shield)\n\n# About\n\nSceptre is a tool to drive\n[AWS CloudFormation](https://aws.amazon.com/cloudformation). It automates the\nmundane, repetitive and error-prone tasks, enabling you to concentrate on\nbuilding better infrastructure.\n\n# Install\n\n`$ pip install sceptre-core`\n\nMore information on installing sceptre can be found in our\n[Installation Guide](https://sceptre.cloudreach.com/latest/docs/install.html)\n\n# Example\n\nSceptre organises Stacks into \"Stack Groups\". Each Stack is represented by a\nYAML configuration file stored in a directory which represents the Stack Group.\nHere, we have two Stacks, `vpc` and `subnets`, in a Stack Group named `dev`:\n\n```\n$ tree\n.\n\u251c\u2500\u2500 config\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 dev\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 config.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 subnets.yaml\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 vpc.yaml\n\u2514\u2500\u2500 templates\n \u251c\u2500\u2500 subnets.py\n \u2514\u2500\u2500 vpc.py\n```\n\n## Usage\n\nSceptre can be used from the CLI (see `sceptre-cli`), or imported as a Python\npackage.\n\n## Python API\n\nUsing Sceptre as a Python module is very straightforward. You need to create a\nSceptreContext, which tells Sceptre where your project path is and which path\nyou want to execute on, we call this the \"command path\".\n\nAfter you have created a SceptreContext you need to pass this into a\nSceptrePlan. On instantiation the SceptrePlan will handle all the required steps\nto make sure the action you wish to take on the command path are resolved.\n\nAfter you have instantiated a SceptrePlan you can access all the actions you can\ntake on a Stack, such as `validate()`, `launch()`, `list()` and `delete()`.\n\n```python\nfrom sceptre.context import SceptreContext\nfrom sceptre.plan.plan import SceptrePlan\n\ncontext = SceptreContext(\"/path/to/project\", \"command_path\")\nplan = SceptrePlan(context)\nplan.launch()\n```\n\nFull API reference documentation can be found in the\n[Documentation](https://sceptre.cloudreach.com/)\n\n# Use Docker Image\n\nView our [Docker repository](https://hub.docker.com/r/cloudreach/sceptre-core).\n\nTo use our Docker image follow these instructions:\n\n1. Pull the image `docker pull cloudreach/sceptre-core:[SCEPTRE_VERSION_NUMBER]`\n e.g. `docker pull cloudreach/sceptre-core:x.x.x`. Leave out the version\n number if you wish to run `latest` or run\n `docker pull cloudreach/sceptre-core:latest`.\n\n2. Run the image. You will need to mount the working directory where your\n project resides to a directory called `project`. You will also need to mount\n a volume with your AWS config to your docker container. E.g.\n\nIf you want to use a custom ENTRYPOINT simply amend the Docker command:\n\n`docker run -ti --entrypoint='' cloudreach/sceptre-core:latest sh`\n\nThe above command will enter you into the shell of the Docker container where\nyou can execute sceptre commands - useful for development.\n\nIf you have any other environment variables in your non-docker shell you will\nneed to pass these in on the Docker CLI using the `-e` flag. See Docker\ndocumentation on how to achieve this.\n\n## Tutorial and Documentation\n\n- [Get Started](https://sceptre.cloudreach.com/latest/docs/get_started.html)\n- [Documentation](https://sceptre.cloudreach.com/)\n\n## Contributing\n\nSee our [Contributing Guide](CONTRIBUTING.md)\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/cloudreach/sceptre", "keywords": "sceptre", "license": "Apache2", "maintainer": "", "maintainer_email": "", "name": "sceptre-core", "package_url": "https://pypi.org/project/sceptre-core/", "platform": "", "project_url": "https://pypi.org/project/sceptre-core/", "project_urls": { "Homepage": "https://github.com/cloudreach/sceptre" }, "release_url": "https://pypi.org/project/sceptre-core/0.0.2/", "requires_dist": [ "boto3 (<2.0,>=1.3)", "PyYaml (<6.0,>=5.1)", "Jinja2 (<3,>=2.8)", "packaging (==16.8)", "six (<2.0.0,>=1.11.0)", "networkx (==2.1)", "pytest (>=3.2) ; extra == 'test'", "troposphere (>=2.0.0) ; extra == 'test'", "moto (==1.3.8) ; extra == 'test'", "mock (==2.0.0) ; extra == 'test'", "behave (==1.2.5) ; extra == 'test'", "freezegun (==0.3.12) ; extra == 'test'", "sceptre-aws-stackoutput-external-resolver (==1.0.0) ; extra == 'test'", "sceptre-aws-stackoutput-resolver (==1.0.0) ; extra == 'test'" ], "requires_python": "", "summary": "Cloud Provisioning Tool", "version": "0.0.2" }, "last_serial": 5540263, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "d3a4655dc041b7521d45db6de1204847", "sha256": "e91ba8dc22bfa2f84cf569b9b4d2994e6da39c182bde9168b79cfb23fe52e38c" }, "downloads": -1, "filename": "sceptre_core-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d3a4655dc041b7521d45db6de1204847", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 36124, "upload_time": "2019-07-16T10:12:03", "url": "https://files.pythonhosted.org/packages/44/b9/01977debae0410c797a0fc2039233bb7b1599d49797cd28fae1918a9842f/sceptre_core-0.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "63a923975686ff72f22cb53679f8f041", "sha256": "3addeeea60b351abcb2a429351db1d6243eabd9d5e0d01a15b2ddfc772a03088" }, "downloads": -1, "filename": "sceptre-core-0.0.1.tar.gz", "has_sig": false, "md5_digest": "63a923975686ff72f22cb53679f8f041", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 69569, "upload_time": "2019-07-16T10:12:05", "url": "https://files.pythonhosted.org/packages/60/65/00b2c66144048940efcda904314d1eb7ad6df3f9c3c826495c52d0341f04/sceptre-core-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "9dfd1451de69d788d7c45809d889e9fc", "sha256": "4d944e7d5a02ce3f9e6b3516eb11d0da9d540eddf8b893bd9f10d22d16f161e3" }, "downloads": -1, "filename": "sceptre_core-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9dfd1451de69d788d7c45809d889e9fc", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 36595, "upload_time": "2019-07-16T12:25:12", "url": "https://files.pythonhosted.org/packages/0b/b2/5a2a2353be8fc570cb0da2b658475dfae53b6f3d53086c1fc6ffb1c4a36c/sceptre_core-0.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "066eb76259e75aeb228b57a3f71c056e", "sha256": "4c9768aaa3b38b9e9feffbc13a2ad54b9bd790a64c1c5c0b0cc477a381aff501" }, "downloads": -1, "filename": "sceptre-core-0.0.2.tar.gz", "has_sig": false, "md5_digest": "066eb76259e75aeb228b57a3f71c056e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 72053, "upload_time": "2019-07-16T12:25:13", "url": "https://files.pythonhosted.org/packages/8b/3a/fdb505b9e76b6178dc0eeb541cdd0e2f23ff0139a5e96c53d0e240f33b8e/sceptre-core-0.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9dfd1451de69d788d7c45809d889e9fc", "sha256": "4d944e7d5a02ce3f9e6b3516eb11d0da9d540eddf8b893bd9f10d22d16f161e3" }, "downloads": -1, "filename": "sceptre_core-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9dfd1451de69d788d7c45809d889e9fc", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 36595, "upload_time": "2019-07-16T12:25:12", "url": "https://files.pythonhosted.org/packages/0b/b2/5a2a2353be8fc570cb0da2b658475dfae53b6f3d53086c1fc6ffb1c4a36c/sceptre_core-0.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "066eb76259e75aeb228b57a3f71c056e", "sha256": "4c9768aaa3b38b9e9feffbc13a2ad54b9bd790a64c1c5c0b0cc477a381aff501" }, "downloads": -1, "filename": "sceptre-core-0.0.2.tar.gz", "has_sig": false, "md5_digest": "066eb76259e75aeb228b57a3f71c056e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 72053, "upload_time": "2019-07-16T12:25:13", "url": "https://files.pythonhosted.org/packages/8b/3a/fdb505b9e76b6178dc0eeb541cdd0e2f23ff0139a5e96c53d0e240f33b8e/sceptre-core-0.0.2.tar.gz" } ] }