# PCF Tile Generator
PCF Tile Generator is a suite of tools to help you develop, package, test,
and deploy services and other add-ons to Pivotal Cloud Foundry. The tile generator
uses templates and patterns that are based on years of experience integrating
third-party services into Cloud Foundry, and eliminates much of the need for
you to have intimate knowledge of all the tools involved.
- Documentation: [Pivotal Documentation](http://docs.pivotal.io/tiledev/tile-generator.html)
- PCF Tile Developers Guide: [Pivotal Documentation](http://docs.pivotal.io/tiledev/index.html)
- Roadmap: [Github Issues](https://github.com/cf-platform-eng/tile-generator/issues)
- CI Pipeline: [TPE Concourse](https://tpe-concourse-rock.acc.broadcom.net/teams/ppe-isv/pipelines/tile-generator/)
## Continuous Integration
GCP project used in CI - **isv-tile-partners**
The master branch of this repository is being monitored by
[this TPE Concourse pipeline](https://tpe-concourse-rock.acc.broadcom.net/teams/ppe-isv/pipelines/tile-generator/).
The pipeline verifies that:
- The tile generator passes all unit tests in `tile_generator/*_unittest.py`
- The tile generator successfully builds the sample tile in `sample`
- The generated tile passes all acceptance tests in `ci/acceptance-tests`
- The generated tile successfully deploys to a current version of PCF
- The deployed tile passes all deployment tests in `ci/deployment-tests`
## Updating pipeline.yml
- After updating the pipeline template file - pipeline.yml.jinja2, please run the below script to generate the pipeline file from inside the ci directory
```
python3 generate_pipeline_yml.py
```
To target the pipeline run the following command
```
fly login -t <desired_target_name> -c https://tpe-concourse-rock.acc.broadcom.net -n ppe-isv
```
You need to be a member of the ppe-isv team for the above command to work.
## Contributing to the Tile Generator
We welcome comments, questions, and contributions from community members. Please consider
the following ways to contribute:
- File Github issues for questions, bugs and new features and comment and vote on the ones that you are interested in.
- If you want to contribute code, please make your code changes on a fork of this repository and submit a
pull request to the master branch of tile-generator. We strongly suggest that you first file an issue to
let us know of your intent, or comment on the issue you are planning to address.
### Development
For development, it is useful to install the tile-generator package in
*editable* mode. That is, you can install the tile-generator package
in a way that points to your local repository, so that your code
changes are immediately available through the `tile` or `pcf`
commands. To do this, run this command in your tile-generator
repository directory:
```
./install-git-hook.sh
pip install -e .
```
To avoid downloading dependencies on every `tile build`:
1. `cd sample`
2. `mkdir cache`
3. `tile build --cache cache`
To verify if there are any lint issues:
```
python -m tabnanny tile_generator/opsmgr.py
```
Run indiv
Before executing `./scripts/run_local_tests.sh` install virtualenv with `pip install virtualenv`
Then to execute all test using the cache from the project root use:
`./scripts/run_local_tests.sh withcache`
### Note: Mac Binaries are no longer supported
Tile generator cli no longer releases new Mac binaries. Check the [commit](https://github.com/cf-platform-eng/tile-generator/commit/1e8db6fb25f1c0e499965df0a113818188548d5b) that removed support for Mac support. MacStadium account has been cancelled and we currently don't have a way to test tile generator cli Mac binaries.
Raw data
{
"_id": null,
"home_page": "https://github.com/cf-platform-eng/tile-generator",
"name": "tile-generator",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pivotal cloud foundry, tile, generator",
"author": "Pivotal Cloud Foundry Platform Engineering",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1b/8b/b5864c9aeffb5fad5ac6088d2957c7b528f42f6a116c860bb52178d88427/tile-generator-15.2.0.tar.gz",
"platform": null,
"description": "# PCF Tile Generator\n\nPCF Tile Generator is a suite of tools to help you develop, package, test,\nand deploy services and other add-ons to Pivotal Cloud Foundry. The tile generator\nuses templates and patterns that are based on years of experience integrating\nthird-party services into Cloud Foundry, and eliminates much of the need for\nyou to have intimate knowledge of all the tools involved.\n\n- Documentation: [Pivotal Documentation](http://docs.pivotal.io/tiledev/tile-generator.html)\n- PCF Tile Developers Guide: [Pivotal Documentation](http://docs.pivotal.io/tiledev/index.html)\n- Roadmap: [Github Issues](https://github.com/cf-platform-eng/tile-generator/issues)\n- CI Pipeline: [TPE Concourse](https://tpe-concourse-rock.acc.broadcom.net/teams/ppe-isv/pipelines/tile-generator/)\n\n## Continuous Integration\n\nGCP project used in CI - **isv-tile-partners**\n\nThe master branch of this repository is being monitored by\n[this TPE Concourse pipeline](https://tpe-concourse-rock.acc.broadcom.net/teams/ppe-isv/pipelines/tile-generator/).\nThe pipeline verifies that:\n\n- The tile generator passes all unit tests in `tile_generator/*_unittest.py`\n- The tile generator successfully builds the sample tile in `sample`\n- The generated tile passes all acceptance tests in `ci/acceptance-tests`\n- The generated tile successfully deploys to a current version of PCF\n- The deployed tile passes all deployment tests in `ci/deployment-tests`\n\n## Updating pipeline.yml\n- After updating the pipeline template file - pipeline.yml.jinja2, please run the below script to generate the pipeline file from inside the ci directory\n```\npython3 generate_pipeline_yml.py\n``` \n\nTo target the pipeline run the following command\n\n```\nfly login -t <desired_target_name> -c https://tpe-concourse-rock.acc.broadcom.net -n ppe-isv\n```\n\nYou need to be a member of the ppe-isv team for the above command to work.\n\n## Contributing to the Tile Generator\n\nWe welcome comments, questions, and contributions from community members. Please consider\nthe following ways to contribute:\n\n- File Github issues for questions, bugs and new features and comment and vote on the ones that you are interested in.\n- If you want to contribute code, please make your code changes on a fork of this repository and submit a\npull request to the master branch of tile-generator. We strongly suggest that you first file an issue to\nlet us know of your intent, or comment on the issue you are planning to address.\n\n### Development\n\nFor development, it is useful to install the tile-generator package in\n*editable* mode. That is, you can install the tile-generator package\nin a way that points to your local repository, so that your code\nchanges are immediately available through the `tile` or `pcf`\ncommands. To do this, run this command in your tile-generator\nrepository directory:\n\n```\n./install-git-hook.sh\npip install -e .\n```\n\nTo avoid downloading dependencies on every `tile build`:\n1. `cd sample`\n2. `mkdir cache`\n3. `tile build --cache cache`\n\nTo verify if there are any lint issues:\n```\npython -m tabnanny tile_generator/opsmgr.py\n```\n\nRun indiv\n\nBefore executing `./scripts/run_local_tests.sh` install virtualenv with `pip install virtualenv`\n\nThen to execute all test using the cache from the project root use: \n`./scripts/run_local_tests.sh withcache`\n\n### Note: Mac Binaries are no longer supported\n\nTile generator cli no longer releases new Mac binaries. Check the [commit](https://github.com/cf-platform-eng/tile-generator/commit/1e8db6fb25f1c0e499965df0a113818188548d5b) that removed support for Mac support. MacStadium account has been cancelled and we currently don't have a way to test tile generator cli Mac binaries.\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Tools supporting development of Pivotal Cloud Foundry services and add-ons.",
"version": "15.2.0",
"project_urls": {
"Homepage": "https://github.com/cf-platform-eng/tile-generator"
},
"split_keywords": [
"pivotal cloud foundry",
" tile",
" generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b8bb5864c9aeffb5fad5ac6088d2957c7b528f42f6a116c860bb52178d88427",
"md5": "634c6436642a8537077d5749d24f963a",
"sha256": "517d90419da1b0f2ba45f41fa820bdf9c19f1ff0426558ae1b57d13ba9868ed8"
},
"downloads": -1,
"filename": "tile-generator-15.2.0.tar.gz",
"has_sig": false,
"md5_digest": "634c6436642a8537077d5749d24f963a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 70338,
"upload_time": "2024-11-22T23:19:10",
"upload_time_iso_8601": "2024-11-22T23:19:10.008039Z",
"url": "https://files.pythonhosted.org/packages/1b/8b/b5864c9aeffb5fad5ac6088d2957c7b528f42f6a116c860bb52178d88427/tile-generator-15.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 23:19:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cf-platform-eng",
"github_project": "tile-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "tile-generator"
}
JSON
