A Python package for easily implementing Concourse [resource types](https://concourse-ci.org/implementing-resource-types.html).
## About
[Concourse CI](https://concourse-ci.org/) is an "open-source continuous thing-doer" designed to enable general automation with intuitive and re-usable components. Resources represent all external inputs and outputs to and from the pipeline, and many of these have been implemented in open source. In order to best leverage the Python ecosystem of open-source packages, Concourse Tools abstracts away the implementation details of Concourse resource types to allow users to focus on writing the code they want to run.
## Installation
Install from [GitHub](https://github.com/gchq/ConcourseTools/), or from [PyPI](https://pypi.org/project/concoursetools/):
```shell
$ pip install concoursetools
```
## Usage
Creating a Concourse resource type with Concourse Tools couldn't be simpler:
1. Create subclasses of `concoursetools.version.Version` and `concoursetools.resource.ConcourseResource`, taking care to implement any required functions.
2. Create a Dockerfile containing your requirements and calling your resource.
3. Upload the Docker image to a registry, and use it in your pipelines!
For more information, see the [documentation](https://concoursetools.readthedocs.io/en/stable/).
## Bugs and Contributions
Concourse Tools is in beta, and still under somewhat-active development. Contributions, fixes, suggestions and bug reports are all welcome: Please familiarise yourself with our [contribution guidelines](https://github.com/gchq/ConcourseTools/blob/main/CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/gchq/ConcourseTools/",
"name": "concoursetools",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "concourse,ci,cd",
"author": "GCHQ",
"author_email": "oss@gchq.gov.uk",
"download_url": "https://files.pythonhosted.org/packages/45/d1/b3c92a51485c9a59ad8ff44c660600e23bf2ca75804e41011e251e657949/concoursetools-0.7.1.tar.gz",
"platform": null,
"description": "\n\n\n\n\n\n\n\nA Python package for easily implementing Concourse [resource types](https://concourse-ci.org/implementing-resource-types.html).\n\n\n## About\n\n[Concourse CI](https://concourse-ci.org/) is an \"open-source continuous thing-doer\" designed to enable general automation with intuitive and re-usable components. Resources represent all external inputs and outputs to and from the pipeline, and many of these have been implemented in open source. In order to best leverage the Python ecosystem of open-source packages, Concourse Tools abstracts away the implementation details of Concourse resource types to allow users to focus on writing the code they want to run.\n\n\n## Installation\n\nInstall from [GitHub](https://github.com/gchq/ConcourseTools/), or from [PyPI](https://pypi.org/project/concoursetools/):\n\n```shell\n$ pip install concoursetools\n```\n\n## Usage\n\nCreating a Concourse resource type with Concourse Tools couldn't be simpler:\n\n1. Create subclasses of `concoursetools.version.Version` and `concoursetools.resource.ConcourseResource`, taking care to implement any required functions.\n2. Create a Dockerfile containing your requirements and calling your resource.\n3. Upload the Docker image to a registry, and use it in your pipelines!\n\nFor more information, see the [documentation](https://concoursetools.readthedocs.io/en/stable/).\n\n\n## Bugs and Contributions\n\nConcourse Tools is in beta, and still under somewhat-active development. Contributions, fixes, suggestions and bug reports are all welcome: Please familiarise yourself with our [contribution guidelines](https://github.com/gchq/ConcourseTools/blob/main/CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Easily create Concourse resource types in Python.",
"version": "0.7.1",
"project_urls": {
"Bug Tracker": "https://github.com/gchq/ConcourseTools/issues",
"Documentation": "https://concoursetools.readthedocs.io/en/stable/",
"Homepage": "https://github.com/gchq/ConcourseTools/",
"Source Code": "https://github.com/gchq/ConcourseTools/"
},
"split_keywords": [
"concourse",
"ci",
"cd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1d2fc0740c01c474d6b538e587f8ead041fca81ad7301d0dbabb2b8f719ffca",
"md5": "9960d2bf4440ecffe38ee8eeea310e02",
"sha256": "7c80adee5ae6c4bc1ca1bc08fb391a2664ffd5a2a9d9f0ea3ae82551fb06cf5f"
},
"downloads": -1,
"filename": "concoursetools-0.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9960d2bf4440ecffe38ee8eeea310e02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 38182,
"upload_time": "2023-09-04T12:58:22",
"upload_time_iso_8601": "2023-09-04T12:58:22.194435Z",
"url": "https://files.pythonhosted.org/packages/a1/d2/fc0740c01c474d6b538e587f8ead041fca81ad7301d0dbabb2b8f719ffca/concoursetools-0.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "45d1b3c92a51485c9a59ad8ff44c660600e23bf2ca75804e41011e251e657949",
"md5": "cade1c0682f01108b6cfc4676491e468",
"sha256": "991ec7b74807030c98612685e23c1ddcc2f87e2087a51cc1754806490675ca81"
},
"downloads": -1,
"filename": "concoursetools-0.7.1.tar.gz",
"has_sig": false,
"md5_digest": "cade1c0682f01108b6cfc4676491e468",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 44878,
"upload_time": "2023-09-04T12:58:24",
"upload_time_iso_8601": "2023-09-04T12:58:24.121879Z",
"url": "https://files.pythonhosted.org/packages/45/d1/b3c92a51485c9a59ad8ff44c660600e23bf2ca75804e41011e251e657949/concoursetools-0.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-04 12:58:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gchq",
"github_project": "ConcourseTools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "concoursetools"
}
JSON
