0.1.0
Project description
cartocss-doc-parser
CartoCSS documentation parser.
Install
pip install cartocss-doc-parser
Quickstart
The main function cartocss_doc returns a dictionary with almost every section of the documentation. All the properties are wrapped in generators.
>>> from pprint import pprint
>>> from cartocss_doc_parser import cartocss_doc
>>>
>>> doc = cartocss_doc()
>>> pprint(doc)
{'building': <generator object ...>,
'common_elements': <generator object ...>,
'line': <generator object ...>,
'line_pattern': <generator object ...>,
'map_background_and_string_elements': <generator object ...>,
'markers': <generator object ...>,
'other_parameters': <generator object ...>,
'point': <generator object ...>,
'polygon': <generator object ...>,
'polygon_pattern': <generator object ...>,
'raster': <generator object ...>,
'shield': <generator object ...>,
'symbolizers': <generator object ...>,
'text': <generator object ...>,
'torque_properties': <generator object ...>,
'values': <generator object ...>}
All properties contains the attributes
default
Default value.description
Description.id
Identificator.link
Link to the property on documentation.name
Name of the property.sample
Example of use.type
Value data type. For a complete list see cartocss_data_types.
and if the data type is keyword
contains an additional attribute
variants
Possible values for the property.
>>> pprint(list(doc["polygon"]))
[{'default': 'gray',
'description': 'The fill color assigned to a polygon.',
'id': 'polygon-fill-color',
'link': 'https://carto.com/developers/styling/cartocss/#polygon-fill-color',
'name': 'polygon-fill',
'sample': 'polygon-fill: rgba(128, 128, 128, 1);',
'type': 'color'},
{'default': '1',
'description': 'The opacity of the polygon.',
'id': 'polygon-opacity-float',
'link': 'https://carto.com/developers/styling/cartocss/#polygon-opacity-float',
'name': 'polygon-opacity',
'sample': 'polygon-opacity: 1;',
'type': 'float'},
...,
{'default': 'power',
'description': 'An anti-grain geometry method that represents a 2D rendering '
'library, specific to controlling the quality of antialiasing '
'and used to calculate pixel gamma (pow(x,gamma), which '
'produces slightly smoother line and polygon antialiasing '
"than the 'linear' method.",
'id': 'polygon-gamma-method-keyword',
'link': 'https://carto.com/developers/styling/cartocss/#polygon-gamma-method-keyword',
'name': 'polygon-gamma-method',
'sample': 'polygon-gamma-method: power;',
'type': 'keyword',
'variants': ['power', 'linear', 'none', 'threshold', 'multiply']},
...
]
All data types can be requested with cartocss_data_types function:
>>> from cartocss_doc_parser import cartocss_data_types
>>> pprint(list(cartocss_data_types()))
['color',
'float',
'uri',
'string',
'boolean',
'expression',
'numbers',
'number',
'percentages',
'percentage',
'functions',
'function',
'keyword',
'unsigned',
'tags']
Documentation
# cartocss_doc(url="https://carto.com/developers/styling/cartocss/", user_agent="cartocss_doc_parser vX.Y.Z") ⇒ dict
Provides information for almost every section of CartoCSS documentation.
- url (str) URL to the documentation page. Can be a local file, in which case any HTTP request would be performed, instead the file would be read.
- user_agent (str) User agent performing the HTTP request to documentation page. As default is
cartocss_doc_parser (v%(version)s)
.
# cartocss_data_types(url="https://carto.com/developers/styling/cartocss/", user_agent="cartocss_doc_parser vX.Y.Z") ⇒ gen
Lists all available data types for properties for CartoCSS.
- url (str) URL to the documentation page. Can be a local file, in which case any HTTP request would be performed, instead the file would be read.
- user_agent (str) User agent performing the HTTP request to documentation page. As default is
cartocss_doc_parser (v%(version)s)
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cartocss-doc-parser-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e150f8f171a79e2ba4c19de22ead00a788035fd8fa142c87e99945cb7bdaa9d9 |
|
MD5 | d0ea74806430792c633746d1637778ea |
|
BLAKE2b-256 | 56cdf0c2b4b63ba87da511dfab31695c9b9846b03804f4a6144a571f702eed2c |
Hashes for cartocss_doc_parser-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 530ee5c9171630d621e68af08d395bad63ce9ff1d376eeefcbbeeb037e00d323 |
|
MD5 | 13aa74ba397db8456584482c7f9a4d33 |
|
BLAKE2b-256 | ea0e41728cc18c1c4f7a256b678a5e72bb5166ea0954a4ae451b3844e574b1d6 |