diff --git a/README.rst b/README.rst index ba83d3e..3276e91 100644 --- a/README.rst +++ b/README.rst @@ -29,16 +29,41 @@ Quick Start Example .. code-block:: python >>> from nameparser import parse - >>> name = parse("Dr. Juan Q. Xavier de la Vega III") - >>> name.given, name.family - ('Juan', 'de la Vega') + >>> name = parse("Dr. Juan Q. Xavier de la Vega III (Doc Vega)") + >>> name + + >>> name.family_base, name.family_particles + ('Vega', 'de la') >>> name.render("{family}, {given}") 'de la Vega, Juan' -Those seven fields are ``title``, ``given``, ``middle``, ``family``, -``suffix``, ``nickname``, and ``maiden`` — plus aggregate views like -``given_names``, ``surnames``, ``family_base``, and ``family_particles`` -for combining or splitting them further. + >>> parse("김민준").family # Korean: unspaced, split on the census list + '김' + >>> parse("高橋 みなみ").family # Japanese: kanji with kana, family first + '高橋' + >>> parse("김민준씨").suffix # an honorific written against the name + '씨' + >>> parse("г-н Иван Петров").title # Cyrillic title + 'г-н' + >>> parse("محمد بن سلمان").family # Arabic: بن chains onto the family name + 'بن سلمان' + + >>> from nameparser import locales, parser_for + >>> chinese = parser_for(locales.ZH) # Han text does not say which language + >>> chinese.parse("毛泽东").family # so splitting it is opt-in + '毛' + >>> russian = parser_for(locales.RU) + >>> russian.parse("Сидоров Иван Петрович").family + 'Сидоров' + >>> locales.available() + ('ja', 'ru', 'tr_az', 'zh') Learn more ----------