Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 3.19 KB

readme.md

File metadata and controls

60 lines (37 loc) · 3.19 KB

Readme metadata tools

The following scripts are used to manage sample content:

  • sample_metadata.py - Sample information model. Includes methods for reading a sample from metadata, rewriting metadata, and otherwise manipulating samples.
  • process_metadata.py - Tools for managing all metadata content. Features include the ability to read all samples and produce an updated TOC, the ability to read source readme content and update existing samples, and tools for keeping readmes and metadata.json files in sync.
  • generate_sample_solutions.py - Tools for extracting samples from the samples viewer and producing standalone Visual Studio solutions. This is used as part of the documentation build process for the ArcGIS Runtime SDK.
  • csproj_utils.py - Tools for generating csproj XML for certain sample elements. Used by generate_sample_solutions.py.
  • file_utils.py - Tools for reading and writing files that are resilient to encoding issues.

The templates folder contains solution templates used by generate_sample_solutions.py.

Requirements

  • requests - available on pip. This is used by sample_metadata.py to read information about offline data items from ArcGIS Online.
  • Python 3.7+ - tested on Python 3.7. The scripts make extensive use of newer Python features, like f strings.

Running process_metadata.py

This script has three modes:

  • toc - reads all sample metadata and produces an up-to-date TOC with sample name, link, and description.
  • improve - attempts to take a readme from another source. If it is better than what is in the samples repo (has more content), its contents are inserted into the samples readme and metadata.
  • sync - reads each readme and rewrites the associated json metadata as needed.

toc

Usage: python process_metadata.py toc {path_to_samples_repo}\src

improve

Usage: python process_metadata.py improve {path_to_samples}\src {path_to_common}

The common readme path should contain folders. The content will only be considered if the folder name matches the sample name exactly.

sync

Usage: python process_metadata.py sync {path_to_samples}\src

This will read each sample's readme, populate the information model, then write out json.

Note: currently this implementation is naive; if there is something special about the existing json (maybe it uses a non-Runtime package), it will be indiscriminately overwritten.

Running generate_sample_solutions.py

This script will read all of the samples for a platform and produce standalone solutions for each.

Usage: python3 generate_sample_solutions.py {platform} {path_to_samples} {output_root}

Platform must be one of:

  • WPF
  • UWP
  • Android
  • iOS
  • XFI - Xamarin.Forms iOS
  • XFA - Xamarin.Forms Android
  • XFU - Xamarin.Forms UWP

Solutions will be produced in a flat directory structure within a platform-specific folder in {output_root}. Inside each platform folder will be a .bat file you can use to build each solution.