{"id":15374764,"url":"https://github.com/mondeja/cartocss-doc-parser","last_synced_at":"2026-03-14T23:36:59.572Z","repository":{"id":45191067,"uuid":"266076348","full_name":"mondeja/cartocss-doc-parser","owner":"mondeja","description":"CartoCSS styling documentation parser","archived":false,"fork":false,"pushed_at":"2024-09-03T21:04:56.000Z","size":246,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-05T06:50:37.884Z","etag":null,"topics":["cartocss","parser"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mondeja.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-05-22T09:52:12.000Z","updated_at":"2022-01-02T11:39:24.000Z","dependencies_parsed_at":"2024-03-20T14:59:40.176Z","dependency_job_id":null,"html_url":"https://github.com/mondeja/cartocss-doc-parser","commit_stats":{"total_commits":138,"total_committers":5,"mean_commits":27.6,"dds":"0.42028985507246375","last_synced_commit":"150e6971f19990e194f3f73eff01d1c3526311b0"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mondeja%2Fcartocss-doc-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mondeja%2Fcartocss-doc-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mondeja%2Fcartocss-doc-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mondeja%2Fcartocss-doc-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mondeja","download_url":"https://codeload.github.com/mondeja/cartocss-doc-parser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219843079,"owners_count":16556591,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cartocss","parser"],"created_at":"2024-10-01T13:59:43.167Z","updated_at":"2025-12-26T00:24:13.555Z","avatar_url":"https://github.com/mondeja.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cartocss-doc-parser\n\n[![PyPI][pypi-version-image]][pypi-link]\n[![Python versions][pypi-pyversions-image]][pypi-link]\n[![Tests][tests-image]][tests-link]\n[![Coverage Status][coverage-image]][coverage-link]\n\n\n[CartoCSS documentation][cartocss-doc-link] Python parser.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"512\" height=\"512\" src=\"https://raw.githubusercontent.com/mondeja/cartocss-doc-parser/master/cartocss-doc-parsed.png\"\u003e\n\u003c/p\u003e\n\n## Install\n\n```bash\npip install cartocss-doc-parser\n```\n\n## Quickstart\n\nThe main function [cartocss_doc](#cartocss_doc) returns a dictionary with\nalmost every section of the documentation. All the properties are wrapped in\ngenerators.\n\n```python\n\u003e\u003e\u003e from pprint import pprint\n\u003e\u003e\u003e from cartocss_doc_parser import cartocss_doc\n\u003e\u003e\u003e\n\u003e\u003e\u003e doc = cartocss_doc()\n\u003e\u003e\u003e pprint(doc)\n{'building': \u003cgenerator object ...\u003e,\n 'common_elements': \u003cgenerator object ...\u003e,\n 'line': \u003cgenerator object ...\u003e,\n 'line_pattern': \u003cgenerator object ...\u003e,\n 'map_background_and_string_elements': \u003cgenerator object ...\u003e,\n 'markers': \u003cgenerator object ...\u003e,\n 'other_parameters': \u003cgenerator object ...\u003e,\n 'point': \u003cgenerator object ...\u003e,\n 'polygon': \u003cgenerator object ...\u003e,\n 'polygon_pattern': \u003cgenerator object ...\u003e,\n 'raster': \u003cgenerator object ...\u003e,\n 'shield': \u003cgenerator object ...\u003e,\n 'symbolizers': \u003cgenerator object ...\u003e,\n 'text': \u003cgenerator object ...\u003e,\n 'torque_properties': \u003cgenerator object ...\u003e,\n 'values': \u003cgenerator object ...\u003e}\n```\n\nAll properties contains the attributes\n\n- **`default`** Default value.\n- **`description`** Description.\n- **`id`** Identificator.\n- **`link`** Link to the property on documentation.\n- **`name`** Name of the property.\n- **`sample`** Example of use.\n- **`type`** Value data type. For a complete list see\n [cartocss_data_types](#cartocss_data_types).\n\nand if the data type is `keyword` contains an additional attribute\n\n- **`variants`** Possible values for the property.\n\n```python\n\u003e\u003e\u003e pprint(list(doc[\"polygon\"]))\n[{'default': 'gray',\n  'description': 'The fill color assigned to a polygon.',\n  'id': 'polygon-fill-color',\n  'link': 'https://carto.com/developers/styling/cartocss/#polygon-fill-color',\n  'name': 'polygon-fill',\n  'sample': 'polygon-fill: rgba(128, 128, 128, 1);',\n  'type': 'color'},\n {'default': '1',\n  'description': 'The opacity of the polygon.',\n  'id': 'polygon-opacity-float',\n  'link': 'https://carto.com/developers/styling/cartocss/#polygon-opacity-float',\n  'name': 'polygon-opacity',\n  'sample': 'polygon-opacity: 1;',\n  'type': 'float'},\n ...,\n {'default': 'power',\n  'description': 'An anti-grain geometry method that represents a 2D rendering '\n                 'library, specific to controlling the quality of antialiasing '\n                 'and used to calculate pixel gamma (pow(x,gamma), which '\n                 'produces slightly smoother line and polygon antialiasing '\n                 \"than the 'linear' method.\",\n  'id': 'polygon-gamma-method-keyword',\n  'link': 'https://carto.com/developers/styling/cartocss/#polygon-gamma-method-keyword',\n  'name': 'polygon-gamma-method',\n  'sample': 'polygon-gamma-method: power;',\n  'type': 'keyword',\n  'variants': ['power', 'linear', 'none', 'threshold', 'multiply']},\n ...\n]\n```\n\nAll data types can be requested with [cartocss_data_types](#cartocss_data_types) function:\n\n```python\n\u003e\u003e\u003e from cartocss_doc_parser import cartocss_data_types\n\u003e\u003e\u003e pprint(list(cartocss_data_types()))\n['color',\n 'float',\n 'uri',\n 'string',\n 'boolean',\n 'expression',\n 'numbers',\n 'number',\n 'percentages',\n 'percentage',\n 'functions',\n 'function',\n 'keyword',\n 'unsigned',\n 'tags']\n```\n\n## Documentation\n\n\u003ca name=\"cartocss_doc\" href=\"#cartocss_doc\"\u003e#\u003c/a\u003e \u003cb\u003ecartocss_doc\u003c/b\u003e(\u003ci\u003eurl=\"https://carto.com/developers/styling/cartocss/\"\u003c/i\u003e, \u003ci\u003euser_agent=\"cartocss_doc_parser vX.Y.Z\"\u003c/i\u003e) ⇒ `dict`\n\nProvides information for almost every section of CartoCSS documentation.\n\n- **url** (str) URL to the documentation page. Can be a local file, in which\n case any HTTP request would be performed, instead the file would be read.\n- **user_agent** (str) User agent performing the HTTP request to documentation\n page. As default is `cartocss_doc_parser (v%(version)s)`.\n\n\u003ca name=\"cartocss_data_types\" href=\"#cartocss_data_types\"\u003e#\u003c/a\u003e \u003cb\u003ecartocss_data_types\u003c/b\u003e(\u003ci\u003eurl=\"https://carto.com/developers/styling/cartocss/\"\u003c/i\u003e, \u003ci\u003euser_agent=\"cartocss_doc_parser vX.Y.Z\"\u003c/i\u003e) ⇒ `gen`\n\nLists all available data types for properties for CartoCSS.\n\n- **url** (str) URL to the documentation page. Can be a local file, in which\n case any HTTP request would be performed, instead the file would be read.\n- **user_agent** (str) User agent performing the HTTP request to documentation\n page. As default is `cartocss_doc_parser (v%(version)s)`.\n\n[pypi-link]: https://pypi.org/project/cartocss-doc-parser\n[pypi-version-image]: https://img.shields.io/pypi/v/cartocss-doc-parser\n[pypi-pyversions-image]: https://img.shields.io/pypi/pyversions/cartocss-doc-parser\n[tests-image]: https://img.shields.io/github/actions/workflow/status/mondeja/cartocss-doc-parser/ci.yml?branch=master\u0026logo=github\u0026label=tests\n[tests-link]: https://github.com/mondeja/cartocss-doc-parser/actions?query=workflow%3ATest\n[coverage-image]: https://coveralls.io/repos/github/mondeja/cartocss-doc-parser/badge.svg\n[coverage-link]: https://coveralls.io/github/mondeja/cartocss-doc-parser\n[cartocss-doc-link]: https://carto.com/developers/styling/cartocss\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmondeja%2Fcartocss-doc-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmondeja%2Fcartocss-doc-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmondeja%2Fcartocss-doc-parser/lists"}