pycoast package¶
Submodules¶
pycoast.cw_agg module¶
-
class
pycoast.cw_agg.
ContourWriterAGG
(db_root_path=None)¶ Bases:
pycoast.cw_base.ContourWriterBase
Adds countours from GSHHS and WDBII to images using the AGG engine for high quality images.
Parameters: - db_root_path : str
Path to root dir of GSHHS and WDBII shapefiles
-
add_borders
(image, area_def, resolution='c', level=1, outline='white', width=1, outline_opacity=255, x_offset=0, y_offset=0)¶ Add borders to a PIL image object.
Parameters: - image : object
PIL image object
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3}
Detail level of dataset
- outline : str or (R, G, B), optional
Border color
- width : float, optional
Width of coastline
- outline_opacity : int, optional {0; 255}
Opacity of coastline color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_borders_to_file
(filename, area_def, resolution='c', level=1, outline='white', width=1, outline_opacity=255, x_offset=0, y_offset=0)¶ Add borders to an image file.
Parameters: - image : object
Image file
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3}
Detail level of dataset
- outline : str or (R, G, B), optional
Border color
- width : float, optional
Width of coastline
- outline_opacity : int, optional {0; 255}
Opacity of coastline color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_coastlines
(image, area_def, resolution='c', level=1, fill=None, fill_opacity=255, outline='white', width=1, outline_opacity=255, x_offset=0, y_offset=0)¶ Add coastlines to a PIL image object.
Parameters: - image : object
PIL image object
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3, 4}
Detail level of dataset
- fill : str or (R, G, B), optional
Land color
- fill_opacity : int, optional {0; 255}
Opacity of land color
- outline : str or (R, G, B), optional
Coastline color
- width : float, optional
Width of coastline
- outline_opacity : int, optional {0; 255}
Opacity of coastline color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_coastlines_to_file
(filename, area_def, resolution='c', level=1, fill=None, fill_opacity=255, outline='white', width=1, outline_opacity=255, x_offset=0, y_offset=0)¶ Add coastlines to an image file.
Parameters: - filename : str
Image file
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3, 4}
Detail level of dataset
- fill : str or (R, G, B), optional
Land color
- fill_opacity : int, optional {0; 255}
Opacity of land color
- outline : str or (R, G, B), optional
Coastline color
- width : float, optional
Width of coastline
- outline_opacity : int, optional {0; 255}
Opacity of coastline color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_grid
(image, area_def, Dlonlat, dlonlat, font=None, write_text=True, fill=None, fill_opacity=255, outline='white', width=1, outline_opacity=255, minor_outline='white', minor_width=0.5, minor_outline_opacity=255, minor_is_tick=True, lon_placement='tb', lat_placement='lr')¶ Add a lon-lat grid to a PIL image object
Parameters: - image : object
PIL image object
- proj4_string : str
Projection of area as Proj.4 string
- Dlonlat: (float, float)
Major grid line separation
- dlonlat: (float, float)
Minor grid line separation
- font: Aggdraw Font object, optional
Font for major line markings
- write_text : boolean, optional
Deterine if line markings are enabled
- fill_opacity : int, optional {0; 255}
Opacity of text
- outline : str or (R, G, B), optional
Major line color
- width : float, optional
Major line width
- outline_opacity : int, optional {0; 255}
Opacity of major lines
- minor_outline : str or (R, G, B), optional
Minor line/tick color
- minor_width : float, optional
Minor line width
- minor_outline_opacity : int, optional {0; 255}
Opacity of minor lines/ticks
- minor_is_tick : boolean, optional
Use tick minor line style (True) or full minor line style (False)
-
add_grid_to_file
(filename, area_def, Dlonlat, dlonlat, font=None, write_text=True, fill=None, fill_opacity=255, outline='white', width=1, outline_opacity=255, minor_outline='white', minor_width=0.5, minor_outline_opacity=255, minor_is_tick=True, lon_placement='tb', lat_placement='lr')¶ Add a lon-lat grid to an image.
Parameters: - image : object
PIL image object
- proj4_string : str
Projection of area as Proj.4 string
- Dlonlat: (float, float)
Major grid line separation
- dlonlat: (float, float)
Minor grid line separation
- font: Aggdraw Font object, optional
Font for major line markings
- write_text : boolean, optional
Deterine if line markings are enabled
- fill_opacity : int, optional {0; 255}
Opacity of text
- outline : str or (R, G, B), optional
Major line color
- width : float, optional
Major line width
- outline_opacity : int, optional {0; 255}
Opacity of major lines
- minor_outline : str or (R, G, B), optional
Minor line/tick color
- minor_width : float, optional
Minor line width
- minor_outline_opacity : int, optional {0; 255}
Opacity of minor lines/ticks
- minor_is_tick : boolean, optional
Use tick minor line style (True) or full minor line style (False)
-
add_line
(image, area_def, lonlats, fill=None, fill_opacity=255, outline='white', width=1, outline_opacity=255, x_offset=0, y_offset=0)¶ Add a user defined poly-line from a list of (lon,lat) coordinates.
Parameters: - image : object
PIL image object
- area_def : list [proj4_string, area_extent]
- proj4_string : strProjection of area as Proj.4 stringarea_extent : listArea extent as a list (LL_x, LL_y, UR_x, UR_y)
- lonlats : list of lon lat pairs
e.g. [(10,20),(20,30),…,(20,20)]
- outline : str or (R, G, B), optional
line color
- width : float, optional
line width
- outline_opacity : int, optional {0; 255}
Opacity of lines
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_polygon
(image, area_def, lonlats, fill=None, fill_opacity=255, outline='white', width=1, outline_opacity=255, x_offset=0, y_offset=0)¶ Add a user defined polygon from a list of (lon,lat) coordinates.
Parameters: - image : object
PIL image object
- area_def : list [proj4_string, area_extent]
- proj4_string : strProjection of area as Proj.4 stringarea_extent : listArea extent as a list (LL_x, LL_y, UR_x, UR_y)
- lonlats : list of lon lat pairs
e.g. [(10,20),(20,30),…,(20,20)]
- fill : str or (R, G, B), optional
Polygon fill color
- fill_opacity : int, optional {0; 255}
Opacity of polygon fill
- outline : str or (R, G, B), optional
line color
- width : float, optional
line width
- outline_opacity : int, optional {0; 255}
Opacity of lines
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_rivers
(image, area_def, resolution='c', level=1, outline='white', width=1, outline_opacity=255, x_offset=0, y_offset=0)¶ Add rivers to a PIL image object.
Parameters: - image : object
PIL image object
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11}
Detail level of dataset
- outline : str or (R, G, B), optional
River color
- width : float, optional
Width of coastline
- outline_opacity : int, optional {0; 255}
Opacity of coastline color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_rivers_to_file
(filename, area_def, resolution='c', level=1, outline='white', width=1, outline_opacity=255, x_offset=0, y_offset=0)¶ Add rivers to an image file.
Parameters: - image : object
Image file
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11}
Detail level of dataset
- outline : str or (R, G, B), optional
River color
- width : float, optional
Width of coastline
- outline_opacity : int, optional {0; 255}
Opacity of coastline color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_shapefile_shape
(image, area_def, filename, shape_id, feature_type=None, fill=None, fill_opacity=255, outline='white', width=1, outline_opacity=255, x_offset=0, y_offset=0)¶ Add a single shape file shape from an ESRI shapefile.
Note: To add all shapes in file use the ‘add_shape_file_shapes’ routine
Note: Currently only supports lon-lat formatted coordinates.
Parameters: - image : object
PIL image object
- area_def : list [proj4_string, area_extent]
- proj4_string : strProjection of area as Proj.4 stringarea_extent : listArea extent as a list (LL_x, LL_y, UR_x, UR_y)
- filename : str
Path to ESRI shape file
- shape_id : int
integer id of shape in shape file {0; … }
- feature_type : ‘polygon’ or ‘line’,
only to override the shape type defined in shapefile, optional
- fill : str or (R, G, B), optional
Polygon fill color
- fill_opacity : int, optional {0; 255}
Opacity of polygon fill
- outline : str or (R, G, B), optional
line color
- width : float, optional
line width
- outline_opacity : int, optional {0; 255}
Opacity of lines
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_shapefile_shapes
(image, area_def, filename, feature_type=None, fill=None, fill_opacity=255, outline='white', width=1, outline_opacity=255, x_offset=0, y_offset=0)¶ Add shape file shapes from an ESRI shapefile.
Note: Currently only supports lon-lat formatted coordinates.
Parameters: - image : object
PIL image object
- area_def : list [proj4_string, area_extent]
- proj4_string : strProjection of area as Proj.4 stringarea_extent : listArea extent as a list (LL_x, LL_y, UR_x, UR_y)
- filename : str
Path to ESRI shape file
- feature_type : ‘polygon’ or ‘line’,
only to override the shape type defined in shapefile, optional
- fill : str or (R, G, B), optional
Polygon fill color
- fill_opacity : int, optional {0; 255}
Opacity of polygon fill
- outline : str or (R, G, B), optional
line color
- width : float, optional
line width
- outline_opacity : int, optional {0; 255}
Opacity of lines
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
pycoast.cw_base module¶
-
class
pycoast.cw_base.
ContourWriterBase
(db_root_path=None)¶ Bases:
object
Base class for contourwriters. Do not instantiate.
Parameters: - db_root_path : str
Path to root dir of GSHHS and WDBII shapefiles
-
add_cities
(image, area_def, citylist, font_file, font_size, ptsize, outline, box_outline, box_opacity, db_root_path=None)¶ Add cities (point and name) to a PIL image object
-
add_overlay_from_config
(config_file, area_def)¶ Create and return a transparent image adding all the overlays contained in a configuration file.
Parameters: - config_file : str
Configuration file name
- area_def : object
Area Definition of the creating image
-
add_shapes
(image, area_def, shapes, feature_type=None, x_offset=0, y_offset=0, **kwargs)¶ Draw shape objects to PIL image.
Parameters: - image : Image
PIL Image to draw shapes on
- area_def : (proj_str, area_extent) or AreaDefinition
Geolocation information for the provided image
- shapes: iterable
Series of shape objects from pyshp. Can also be a series of 2-element tuples where the first element is the shape object and the second is a dictionary of additional drawing parameters for this shape.
- feature_type: str
‘polygon’ or ‘line’ or None for what to draw shapes as. Default is to draw the shape with the type in the shapefile.
- kwargs:
Extra drawing keyword arguments for all shapes
pycoast.cw_pil module¶
-
class
pycoast.cw_pil.
ContourWriterPIL
(db_root_path=None)¶ Bases:
pycoast.cw_base.ContourWriterBase
Adds countours from GSHHS and WDBII to images.
Parameters: - db_root_path : str
Path to root dir of GSHHS and WDBII shapefiles
-
add_borders
(image, area_def, resolution='c', level=1, outline='white', x_offset=0, y_offset=0)¶ Add borders to a PIL image object.
Parameters: - image : object
PIL image object
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3}
Detail level of dataset
- outline : str or (R, G, B), optional
Border color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_borders_to_file
(filename, area_def, resolution='c', level=1, outline='white', x_offset=0, y_offset=0)¶ Add borders to an image file.
Parameters: - image : object
Image file
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3}
Detail level of dataset
- outline : str or (R, G, B), optional
Border color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_coastlines
(image, area_def, resolution='c', level=1, fill=None, outline='white', x_offset=0, y_offset=0)¶ Add coastlines to a PIL image object.
Parameters: - image : object
PIL image object
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3, 4}
Detail level of dataset
- fill : str or (R, G, B), optional
Land color
- outline : str or (R, G, B), optional
Coastline color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_coastlines_to_file
(filename, area_def, resolution='c', level=1, fill=None, outline='white', x_offset=0, y_offset=0)¶ Add coastlines to an image file.
Parameters: - filename : str
Image file
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3, 4}
Detail level of dataset
- fill : str or (R, G, B)
Land color
- outline : str or (R, G, B), optional
Coastline color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_grid
(image, area_def, Dlonlat, dlonlat, font=None, write_text=True, fill=None, outline='white', minor_outline='white', minor_is_tick=True, lon_placement='tb', lat_placement='lr')¶ Add a lon-lat grid to a PIL image object.
Parameters: - image : object
PIL image object
- proj4_string : str
Projection of area as Proj.4 string
- Dlonlat: (float, float)
Major grid line separation
- dlonlat: (float, float)
Minor grid line separation
- font: PIL ImageFont object, optional
Font for major line markings
- write_text : boolean, optional
Deterine if line markings are enabled
- fill : str or (R, G, B), optional
Text color
- outline : str or (R, G, B), optional
Major line color
- minor_outline : str or (R, G, B), optional
Minor line/tick color
- minor_is_tick : boolean, optional
Use tick minor line style (True) or full minor line style (False)
-
add_grid_to_file
(filename, area_def, Dlonlat, dlonlat, font=None, write_text=True, fill=None, outline='white', minor_outline='white', minor_is_tick=True, lon_placement='tb', lat_placement='lr')¶ Add a lon-lat grid to an image file.
Parameters: - image : object
PIL image object
- proj4_string : str
Projection of area as Proj.4 string
- Dlonlat: (float, float)
Major grid line separation
- dlonlat: (float, float)
Minor grid line separation
- font: PIL ImageFont object, optional
Font for major line markings
- write_text : boolean, optional
Deterine if line markings are enabled
- fill : str or (R, G, B), optional
Text color
- outline : str or (R, G, B), optional
Major line color
- minor_outline : str or (R, G, B), optional
Minor line/tick color
- minor_is_tick : boolean, optional
Use tick minor line style (True) or full minor line style (False)
-
add_line
(image, area_def, lonlats, fill=None, outline='white', x_offset=0, y_offset=0)¶ Add a user defined poly-line from a list of (lon,lat) coordinates.
Parameters: - image : object
PIL image object
- area_def : list [proj4_string, area_extent]
- proj4_string : strProjection of area as Proj.4 stringarea_extent : listArea extent as a list (LL_x, LL_y, UR_x, UR_y)
- lonlats : list of lon lat pairs
e.g. [(10,20),(20,30),…,(20,20)]
- outline : str or (R, G, B), optional
line color
- width : float, optional
line width
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_polygon
(image, area_def, lonlats, fill=None, outline='white', x_offset=0, y_offset=0)¶ Add a user defined polygon from a list of (lon,lat) coordinates.
Parameters: - image : object
PIL image object
- area_def : list [proj4_string, area_extent]
- proj4_string : strProjection of area as Proj.4 stringarea_extent : listArea extent as a list (LL_x, LL_y, UR_x, UR_y)
- lonlats : list of lon lat pairs
e.g. [(10,20),(20,30),…,(20,20)]
- fill : str or (R, G, B), optional
Polygon fill color
- outline : str or (R, G, B), optional
line color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_rivers
(image, area_def, resolution='c', level=1, outline='white', x_offset=0, y_offset=0)¶ Add rivers to a PIL image object.
Parameters: - image : object
PIL image object
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11}
Detail level of dataset
- outline : str or (R, G, B), optional
River color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_rivers_to_file
(filename, area_def, resolution='c', level=1, outline='white', x_offset=0, y_offset=0)¶ Add rivers to an image file.
Parameters: - image : object
Image file
- proj4_string : str
Projection of area as Proj.4 string
- area_extent : list
Area extent as a list (LL_x, LL_y, UR_x, UR_y)
- resolution : str, optional {‘c’, ‘l’, ‘i’, ‘h’, ‘f’}
Dataset resolution to use
- level : int, optional {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11}
Detail level of dataset
- outline : str or (R, G, B), optional
River color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_shapefile_shape
(image, area_def, filename, shape_id, feature_type=None, fill=None, outline='white', x_offset=0, y_offset=0)¶ Add a single shape file shape from an ESRI shapefile.
Note: To add all shapes in file use the ‘add_shape_file_shapes’ routine. Note: Currently only supports lon-lat formatted coordinates.
Parameters: - image : object
PIL image object
- area_def : list [proj4_string, area_extent]
- proj4_string : strProjection of area as Proj.4 stringarea_extent : listArea extent as a list (LL_x, LL_y, UR_x, UR_y)
- filename : str
Path to ESRI shape file
- shape_id : int
integer id of shape in shape file {0; … }
- feature_type : ‘polygon’ or ‘line’,
only to override the shape type defined in shapefile, optional
- fill : str or (R, G, B), optional
Polygon fill color
- outline : str or (R, G, B), optional
line color
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
-
add_shapefile_shapes
(image, area_def, filename, feature_type=None, fill=None, outline='white', x_offset=0, y_offset=0)¶ Add shape file shapes from an ESRI shapefile.
Note: Currently only supports lon-lat formatted coordinates.
Parameters: - image : object
PIL image object
- area_def : list [proj4_string, area_extent]
- proj4_string : strProjection of area as Proj.4 stringarea_extent : listArea extent as a list (LL_x, LL_y, UR_x, UR_y)
- filename : str
Path to ESRI shape file
- feature_type : ‘polygon’ or ‘line’,
only to override the shape type defined in shapefile, optional
- fill : str or (R, G, B), optional
Polygon fill color
- fill_opacity : int, optional {0; 255}
Opacity of polygon fill
- outline : str or (R, G, B), optional
line color
- outline_opacity : int, optional {0; 255}
Opacity of lines
- x_offset : float, optional
Pixel offset in x direction
- y_offset : float, optional
Pixel offset in y direction
pycoast.version module¶
Git implementation of _version.py.
-
exception
pycoast.version.
NotThisMethod
¶ Bases:
Exception
Exception raised if a method is not valid for the current scenario.
-
class
pycoast.version.
VersioneerConfig
¶ Bases:
object
Container for Versioneer configuration parameters.
-
pycoast.version.
get_config
()¶ Create, populate and return the VersioneerConfig() object.
-
pycoast.version.
get_keywords
()¶ Get the keywords needed to look up the version information.
-
pycoast.version.
get_versions
()¶ Get version information or return default if unable to do so.
-
pycoast.version.
git_get_keywords
(versionfile_abs)¶ Extract version information from the given file.
-
pycoast.version.
git_pieces_from_vcs
(tag_prefix, root, verbose, run_command=<function run_command>)¶ Get version from ‘git describe’ in the root of the source tree.
This only gets called if the git-archive ‘subst’ keywords were not expanded, and _version.py hasn’t already been rewritten with a short version string, meaning we’re inside a checked out source tree.
-
pycoast.version.
git_versions_from_keywords
(keywords, tag_prefix, verbose)¶ Get version information from git keywords.
-
pycoast.version.
plus_or_dot
(pieces)¶ Return a + if we don’t already have one, else return a .
-
pycoast.version.
register_vcs_handler
(vcs, method)¶ Decorator to mark a method as the handler for a particular VCS.
-
pycoast.version.
render
(pieces, style)¶ Render the given version pieces into the requested style.
-
pycoast.version.
render_git_describe
(pieces)¶ TAG[-DISTANCE-gHEX][-dirty].
Like ‘git describe –tags –dirty –always’.
Exceptions: 1: no tags. HEX[-dirty] (note: no ‘g’ prefix)
-
pycoast.version.
render_git_describe_long
(pieces)¶ TAG-DISTANCE-gHEX[-dirty].
Like ‘git describe –tags –dirty –always -long’. The distance/hash is unconditional.
Exceptions: 1: no tags. HEX[-dirty] (note: no ‘g’ prefix)
-
pycoast.version.
render_pep440
(pieces)¶ Build up version string, with post-release “local version identifier”.
Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you get a tagged build and then dirty it, you’ll get TAG+0.gHEX.dirty
Exceptions: 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty]
-
pycoast.version.
render_pep440_old
(pieces)¶ TAG[.postDISTANCE[.dev0]] .
The “.dev0” means dirty.
Eexceptions: 1: no tags. 0.postDISTANCE[.dev0]
-
pycoast.version.
render_pep440_post
(pieces)¶ TAG[.postDISTANCE[.dev0]+gHEX] .
The “.dev0” means dirty. Note that .dev0 sorts backwards (a dirty tree will appear “older” than the corresponding clean one), but you shouldn’t be releasing software with -dirty anyways.
Exceptions: 1: no tags. 0.postDISTANCE[.dev0]
-
pycoast.version.
render_pep440_pre
(pieces)¶ TAG[.post.devDISTANCE] – No -dirty.
Exceptions: 1: no tags. 0.post.devDISTANCE
-
pycoast.version.
run_command
(commands, args, cwd=None, verbose=False, hide_stderr=False, env=None)¶ Call the given command(s).
-
pycoast.version.
versions_from_parentdir
(parentdir_prefix, root, verbose)¶ Try to determine the version from the parent directory name.
Source tarballs conventionally unpack into a directory that includes both the project name and a version string. We will also support searching up two directory levels for an appropriately named parent directory
Module contents¶
-
class
pycoast.
ContourWriter
(*args, **kwargs)¶ Bases:
pycoast.cw_pil.ContourWriterPIL
Writer wrapper for deprecation warning.
Deprecated since version 1.2.0: Use
ContourWriterPIL
orContourWriterAGG
instead.