[Python-modules-commits] [python-nameparser] 01/05: Import python-nameparser_0.3.15.orig.tar.gz
Edward Betts
edward at moszumanska.debian.org
Tue Mar 22 08:14:44 UTC 2016
This is an automated email from the git hooks/post-receive script.
edward pushed a commit to branch master
in repository python-nameparser.
commit 48e933fc93e59d44334c441b7586996c77567e96
Author: Edward Betts <edward at 4angle.com>
Date: Tue Mar 22 08:05:12 2016 +0000
Import python-nameparser_0.3.15.orig.tar.gz
---
.gitignore | 17 --
.hgignore | 8 -
.tm_properties | 1 -
.travis.yml | 16 --
CONTRIBUTING.md | 82 ---------
MANIFEST.in | 1 +
PKG-INFO | 157 +++++++++++++++++
README.rst | 2 +-
dev-requirements.txt | 7 -
dist/nameparser-0.1.3.tar.gz | Bin 5247 -> 0 bytes
dist/nameparser-0.1.4.tar.gz | Bin 5744 -> 0 bytes
dist/nameparser-0.2.0.tar.gz | Bin 7206 -> 0 bytes
dist/nameparser-0.2.10.tar.gz | Bin 13655 -> 0 bytes
dist/nameparser-0.2.2.tar.gz | Bin 7571 -> 0 bytes
dist/nameparser-0.2.3.tar.gz | Bin 7781 -> 0 bytes
dist/nameparser-0.2.4.tar.gz | Bin 10240 -> 0 bytes
dist/nameparser-0.2.5.tar.gz | Bin 11074 -> 0 bytes
dist/nameparser-0.2.6.tar.gz | Bin 11129 -> 0 bytes
dist/nameparser-0.2.7.tar.gz | Bin 11625 -> 0 bytes
dist/nameparser-0.2.8.tar.gz | Bin 11777 -> 0 bytes
dist/nameparser-0.2.9.tar.gz | Bin 12394 -> 0 bytes
dist/nameparser-0.3.0.tar.gz | Bin 9438 -> 0 bytes
dist/nameparser-0.3.1.tar.gz | Bin 13904 -> 0 bytes
dist/nameparser-0.3.2.tar.gz | Bin 14135 -> 0 bytes
docs/Makefile | 177 -------------------
docs/conf.py | 290 -------------------------------
docs/contributing.rst | 20 ---
docs/customize.rst | 283 ------------------------------
docs/index.rst | 82 ---------
docs/modules.rst | 36 ----
docs/release_log.rst | 88 ----------
docs/resources.rst | 14 --
docs/usage.rst | 150 ----------------
nameparser.egg-info/PKG-INFO | 157 +++++++++++++++++
nameparser.egg-info/SOURCES.txt | 21 +++
nameparser.egg-info/dependency_links.txt | 1 +
nameparser.egg-info/top_level.txt | 1 +
nameparser/__init__.py | 2 +-
nameparser/config/__init__.py | 3 +-
nameparser/parser.py | 6 +-
setup.cfg | 6 +
setup.py | 1 +
tests.py | 56 ++++--
43 files changed, 390 insertions(+), 1295 deletions(-)
diff --git a/.gitignore b/.gitignore
deleted file mode 100644
index c8428c9..0000000
--- a/.gitignore
+++ /dev/null
@@ -1,17 +0,0 @@
-*.hgrc
-*.DS_Store
-__pycache__/
-*.py[cod]
-.python2/
-MANIFEST
-nameparser.egg-info/
-dummycert.pem
-build
-*.egg
-.env
-.env3
-.coverage
-dist
-
-# docs
-docs/_*
diff --git a/.hgignore b/.hgignore
deleted file mode 100644
index b7123be..0000000
--- a/.hgignore
+++ /dev/null
@@ -1,8 +0,0 @@
-.hgrc
-.DS_Store
-.pyc
-__pycache__
-.python2
-MANIFEST
-nameparser.egg-info/*
-dummycert.pem
\ No newline at end of file
diff --git a/.tm_properties b/.tm_properties
deleted file mode 100644
index 3f04e72..0000000
--- a/.tm_properties
+++ /dev/null
@@ -1 +0,0 @@
-excludeDirectories = "{$excludeDirectories,dist,*.egg-info,build,docs/_*}"
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 571244d..0000000
--- a/.travis.yml
+++ /dev/null
@@ -1,16 +0,0 @@
-language: python
-python:
- - "2.6"
- - "2.7"
- - "3.2"
- - "3.3"
- - "3.4"
- - "3.5"
-# command to install dependencies
-install:
- - if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then pip install --use-mirrors unittest2; fi
- - "pip install dill"
- - "python setup.py install"
-# command to run tests
-script: python tests.py
-sudo: false
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index b4a0208..0000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,82 +0,0 @@
-Contributing
-==============
-
-Development Environment Setup
---------------------------------
-
-There are some exernal dependencies required in order to run the
-tests, located in the dev-requirements.txt file.
-
- pip install -r dev-requirements.txt
-
-If you are running Python 2.6 you will also need to `pip install unitest2`
-in order to run the tests.
-
-Travis CI
----------
-
-[](https://travis-ci.org/derek73/python-nameparser)
-
-The GitHub project is set up with Travis CI. Tests are run
-automatically against new code pushes to any branch in the main
-repository. Test results may be viewed here:
-
-https://travis-ci.org/derek73/python-nameparser
-
-Running Tests
----------------
-
-To run the tests locally, run `python tests.py`.
-
-
- python tests.py
-
-
-You can also pass a name string to `tests.py` to see how it will be parsed.
-
- $ python tests.py "Secretary of State Hillary Rodham-Clinton"
- <HumanName : [
- Title: 'Secretary of State'
- First: 'Hillary'
- Middle: ''
- Last: 'Rodham-Clinton'
- Suffix: ''
- ]>
-
-
-Writing Tests
-----------------
-
-If you make changes, please make sure you include tests with example
-names that you want to be parsed correctly.
-
-It's a good idea to include tests of alternate comma placement formats
-of the name to ensure that the 3 code paths for the 3 formats work in
-the same way.
-
-The tests could be MUCH better. If the spirit moves you to design or
-implement a much more intelligent test strategy, please know that your
-efforts will be welcome and appreciated.
-
-Unless you add better coverage someplace else, add a few examples of
-your names to `TEST_NAMES`. A test attempts to try the 3 different
-comma variations of these names automatically and make sure things
-don't blow up, so it can be a helpful regression indicator.
-
-
-Provide Example Data
-----------------------
-
-We humans are the learning machine behind this code, and we can't do
-it without real world data. If it doesn't work, start a new issue
-because we probably don't know.
-
-If you have a dataset that has lots of issues, add the data to a
-[gist](https://gist.github.com) and [create a new
-issue](https://github.com/derek73/python-nameparser/issues) so we can
-try to get it working as expected.
-
-Feel free to update this documentation to address any questions that I
-missed. GitHub makes it pretty easy to edit it right on the web site
-now.
-
diff --git a/MANIFEST.in b/MANIFEST.in
index 7c985df..b212477 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,4 @@
include AUTHORS
include LICENSE
include README.rst
+include tests.py
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..895bf93
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,157 @@
+Metadata-Version: 1.1
+Name: nameparser
+Version: 0.3.15
+Summary: A simple Python module for parsing human names into their individual components.
+Home-page: https://github.com/derek73/python-nameparser
+Author: Derek Gulbranson
+Author-email: derek73 at gmail.com
+License: LGPL
+Description: Name Parser
+ ===========
+
+ .. image:: https://travis-ci.org/derek73/python-nameparser.svg?branch=master
+ :target: https://travis-ci.org/derek73/python-nameparser
+ .. image:: https://badge.fury.io/py/nameparser.svg
+ :target: http://badge.fury.io/py/nameparser
+
+ A simple Python (3.2+ & 2.6+) module for parsing human names into their
+ individual components.
+
+ * hn.title
+ * hn.first
+ * hn.middle
+ * hn.last
+ * hn.suffix
+ * hn.nickname
+
+ Supports 3 different comma placement variations in the input string.
+
+ 1. Title Firstname "Nickname" Middle Middle Lastname Suffix
+ 2. Lastname [Suffix], Title Firstname (Nickname) Middle Middle[,] Suffix [, Suffix]
+ 3. Title Firstname M Lastname [Suffix], Suffix [Suffix] [, Suffix]
+
+ Instantiating the `HumanName` class with a string splits on commas and then spaces,
+ classifying name parts based on placement in the string and matches against known name
+ pieces like titles and suffixes.
+
+ It correctly handles some common conjunctions and special prefixes to last names
+ like "del". Titles and conjunctions can be chained together to handle complex
+ titles like "Asst Secretary of State". It can also try to correct capitalization
+ of names that are all upper- or lowercase names.
+
+ It attempts the best guess that can be made with a simple, rule-based approach.
+ Its main use case is English and it is not likely to be useful for languages
+ that do not share the same structure as English names. It's not perfect, but it
+ gets you pretty far.
+
+ Installation
+ ------------
+
+ ::
+
+ pip install nameparser
+
+ If you want to try out the latest code from GitHub you can
+ install with pip using the command below.
+
+ ``pip install -e git+git://github.com/derek73/python-nameparser.git#egg=nameparser``
+
+ If you're looking for a web service, check out
+ `eyeseast's nameparse service <https://github.com/eyeseast/nameparse>`_, a
+ simple Heroku-friendly Flask wrapper for this module.
+
+
+ Quick Start Example
+ -------------------
+
+ ::
+
+ >>> from nameparser import HumanName
+ >>> name = HumanName("Dr. Juan Q. Xavier de la Vega III (Doc Vega)")
+ >>> name
+ <HumanName : [
+ title: 'Dr.'
+ first: 'Juan'
+ middle: 'Q. Xavier'
+ last: 'de la Vega'
+ suffix: 'III'
+ nickname: 'Doc Vega'
+ ]>
+ >>> name.last
+ 'de la Vega'
+ >>> name.as_dict()
+ {'last': 'de la Vega', 'suffix': 'III', 'title': 'Dr.', 'middle': 'Q. Xavier', 'nickname': 'Doc Vega', 'first': 'Juan'}
+ >>> name.string_format = "{first} {last}"
+ >>> str(name)
+ 'Juan de la Vega'
+
+
+ The parser does not attempt to correct mistakes in the input. It mostly just splits on white
+ space and puts things in buckets based on their position in the string. This also means
+ the difference between 'title' and 'suffix' is positional, not semantic. "Dr" is a title
+ when it comes before the name and a suffix when it comes after. ("Pre-nominal"
+ and "post-nominal" would probably be better names.)
+
+ ::
+
+ >>> name = HumanName("1 & 2, 3 4 5, Mr.")
+ >>> name
+ <HumanName : [
+ title: ''
+ first: '3'
+ middle: '4 5'
+ last: '1 & 2'
+ suffix: 'Mr.'
+ nickname: ''
+ ]>
+
+ Customization
+ -------------
+
+ Your project may need a bit of adjustments for your dataset. You can
+ do this in your own pre- or post-processing, by `customizing the configured pre-defined
+ sets`_ of titles, prefixes, etc., or by subclassing the `HumanName` class. See the
+ `full documentation`_ for more information.
+
+
+ `Full documentation`_
+ ~~~~~~~~~~~~~~~~~~~~~
+
+ .. _customizing the configured pre-defined sets: http://nameparser.readthedocs.org/en/latest/customize.html
+ .. _Full documentation: http://nameparser.readthedocs.org/en/latest/
+
+
+ Contributing
+ ------------
+
+ If you come across name piece that you think should be in the default config, you're
+ probably right. `Start a New Issue`_ and we can get them added.
+
+ Please let me know if there are ways this library could be structured to make
+ it easier for you to use in your projects. Read CONTRIBUTING.md_ for more info
+ on running the tests and contributing to the project.
+
+ **GitHub Project**
+
+ https://github.com/derek73/python-nameparser
+
+ .. _CONTRIBUTING.md: https://github.com/derek73/python-nameparser/tree/master/CONTRIBUTING.md
+ .. _Start a New Issue: https://github.com/derek73/python-nameparser/issues
+ .. _click here to propose changes to the titles: https://github.com/derek73/python-nameparser/edit/master/nameparser/config/titles.py
+Keywords: names,parser
+Platform: UNKNOWN
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.2
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Natural Language :: English
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Linguistic
diff --git a/README.rst b/README.rst
index facbede..2a78248 100644
--- a/README.rst
+++ b/README.rst
@@ -29,7 +29,7 @@ pieces like titles and suffixes.
It correctly handles some common conjunctions and special prefixes to last names
like "del". Titles and conjunctions can be chained together to handle complex
titles like "Asst Secretary of State". It can also try to correct capitalization
-of all names that are all upper- or lowercase names.
+of names that are all upper- or lowercase names.
It attempts the best guess that can be made with a simple, rule-based approach.
Its main use case is English and it is not likely to be useful for languages
diff --git a/dev-requirements.txt b/dev-requirements.txt
deleted file mode 100644
index 0d116e5..0000000
--- a/dev-requirements.txt
+++ /dev/null
@@ -1,7 +0,0 @@
-ipdb==0.9.0
-nose==1.3.7
-Sphinx==1.3.6
-coverage==4.0.3
-ipython==4.1.2
-Pygments==2.1.3
-dill==0.2.5
diff --git a/dist/nameparser-0.1.3.tar.gz b/dist/nameparser-0.1.3.tar.gz
deleted file mode 100644
index bcecd88..0000000
Binary files a/dist/nameparser-0.1.3.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.1.4.tar.gz b/dist/nameparser-0.1.4.tar.gz
deleted file mode 100644
index 0d5bc52..0000000
Binary files a/dist/nameparser-0.1.4.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.2.0.tar.gz b/dist/nameparser-0.2.0.tar.gz
deleted file mode 100644
index 762e4b0..0000000
Binary files a/dist/nameparser-0.2.0.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.2.10.tar.gz b/dist/nameparser-0.2.10.tar.gz
deleted file mode 100644
index 9b16611..0000000
Binary files a/dist/nameparser-0.2.10.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.2.2.tar.gz b/dist/nameparser-0.2.2.tar.gz
deleted file mode 100644
index 2ea6b63..0000000
Binary files a/dist/nameparser-0.2.2.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.2.3.tar.gz b/dist/nameparser-0.2.3.tar.gz
deleted file mode 100644
index 9c3a582..0000000
Binary files a/dist/nameparser-0.2.3.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.2.4.tar.gz b/dist/nameparser-0.2.4.tar.gz
deleted file mode 100644
index e69c585..0000000
Binary files a/dist/nameparser-0.2.4.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.2.5.tar.gz b/dist/nameparser-0.2.5.tar.gz
deleted file mode 100644
index 4763b8b..0000000
Binary files a/dist/nameparser-0.2.5.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.2.6.tar.gz b/dist/nameparser-0.2.6.tar.gz
deleted file mode 100644
index 48ca49f..0000000
Binary files a/dist/nameparser-0.2.6.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.2.7.tar.gz b/dist/nameparser-0.2.7.tar.gz
deleted file mode 100644
index d8fb242..0000000
Binary files a/dist/nameparser-0.2.7.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.2.8.tar.gz b/dist/nameparser-0.2.8.tar.gz
deleted file mode 100644
index 0db8a4b..0000000
Binary files a/dist/nameparser-0.2.8.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.2.9.tar.gz b/dist/nameparser-0.2.9.tar.gz
deleted file mode 100644
index 5c5d467..0000000
Binary files a/dist/nameparser-0.2.9.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.3.0.tar.gz b/dist/nameparser-0.3.0.tar.gz
deleted file mode 100644
index f2a5672..0000000
Binary files a/dist/nameparser-0.3.0.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.3.1.tar.gz b/dist/nameparser-0.3.1.tar.gz
deleted file mode 100644
index 3e290d0..0000000
Binary files a/dist/nameparser-0.3.1.tar.gz and /dev/null differ
diff --git a/dist/nameparser-0.3.2.tar.gz b/dist/nameparser-0.3.2.tar.gz
deleted file mode 100644
index 5e9812d..0000000
Binary files a/dist/nameparser-0.3.2.tar.gz and /dev/null differ
diff --git a/docs/Makefile b/docs/Makefile
deleted file mode 100644
index ff4d382..0000000
--- a/docs/Makefile
+++ /dev/null
@@ -1,177 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = _build
-
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " singlehtml to make a single large HTML file"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " devhelp to make HTML files and a Devhelp project"
- @echo " epub to make an epub"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
- @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
- @echo " text to make text files"
- @echo " man to make manual pages"
- @echo " texinfo to make Texinfo files"
- @echo " info to make Texinfo files and run them through makeinfo"
- @echo " gettext to make PO message catalogs"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " xml to make Docutils-native XML files"
- @echo " pseudoxml to make pseudoxml-XML files for display purposes"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
-
-clean:
- rm -rf $(BUILDDIR)/*
-
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
- @echo
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Nameparser.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Nameparser.qhc"
-
-devhelp:
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
- @echo
- @echo "Build finished."
- @echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/Nameparser"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Nameparser"
- @echo "# devhelp"
-
-epub:
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
- @echo
- @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
- "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through pdflatex..."
- $(MAKE) -C $(BUILDDIR)/latex all-pdf
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-latexpdfja:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through platex and dvipdfmx..."
- $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
- @echo
- @echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
- @echo
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-texinfo:
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
- @echo
- @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
- @echo "Run \`make' in that directory to run these through makeinfo" \
- "(use \`make info' here to do that automatically)."
-
-info:
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
- @echo "Running Texinfo files through makeinfo..."
- make -C $(BUILDDIR)/texinfo info
- @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
-
-gettext:
- $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
- @echo
- @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
-
-xml:
- $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
- @echo
- @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
-
-pseudoxml:
- $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
- @echo
- @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/docs/conf.py b/docs/conf.py
deleted file mode 100644
index 09c29c1..0000000
--- a/docs/conf.py
+++ /dev/null
@@ -1,290 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Nameparser documentation build configuration file, created by
-# sphinx-quickstart on Fri May 16 01:29:58 2014.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys
-import os
-from datetime import date
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('..'))
-import nameparser
-
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
- 'sphinx.ext.autodoc',
- 'sphinx.ext.doctest',
- 'sphinx.ext.viewcode',
-]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'Nameparser'
-copyright = u'{:%Y}, Derek Gulbranson'.format(date.today())
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = nameparser.__version__
-# The full version, including alpha/beta/rc tags.
-release = version
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = 'alabaster'
-
-import alabaster
-
-html_theme_path = [alabaster.get_path()]
-extensions += ['alabaster']
-html_theme = 'alabaster'
-html_sidebars = {
- '**': [
- 'about.html',
- 'navigation.html',
- 'relations.html',
- 'searchbox.html',
- 'donate.html',
- ]
-}
-html_theme_options = {
- 'github_user': 'derek73',
- 'github_repo': 'python-nameparser',
- 'travis_button': True,
- 'analytics_id': 'UA-339019-11',
-}
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-#html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'Nameparserdoc'
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- ('index', 'Nameparser.tex', u'Nameparser Documentation',
- u'Derek Gulbranson', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- ('index', 'nameparser', u'Nameparser Documentation',
- [u'Derek Gulbranson'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- ('index', 'Nameparser', u'Nameparser Documentation',
- u'Derek Gulbranson', 'Nameparser', 'A simple python modules for parsing human names into components.',
- 'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
-
-doctest_global_setup = """from nameparser import HumanName
-from nameparser.config import CONSTANTS, Constants
-CONSTANTS = Constants()
-"""
diff --git a/docs/contributing.rst b/docs/contributing.rst
deleted file mode 100644
index 90f53d4..0000000
--- a/docs/contributing.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-Contributing
-============
-
-The project is hosted on GitHub:
-
-https://github.com/derek73/python-nameparser
-
-Find more information about running tests and contributing the project at the projects contribution guide.
-
-https://github.com/derek73/python-nameparser/blob/master/CONTRIBUTING.md
-
-Providing Example Data
-----------------------
-
-We humans are the learning machine behind this code, and we can't do it without real world data. If it doesn't work, start a new issue because we probably don't know.
-
-If you have a dataset that has lots of issues, add the data to a [gist](https://gist.github.com) and [create a new issue](https://github.com/derek73/python-nameparser/issues) so we can try to get it working as expected.
-
-Feel free to update this documentation to address any questions that I missed. GitHub makes it pretty easy to edit it right on the web site now.
-
diff --git a/docs/customize.rst b/docs/customize.rst
deleted file mode 100644
index 7c92aca..0000000
--- a/docs/customize.rst
+++ /dev/null
@@ -1,283 +0,0 @@
-Customizing the Parser with Your Own Configuration
-==================================================
-
-Recognition of titles, prefixes, suffixes and conjunctions is handled by
-matching the lower case characters of a name piece with pre-defined sets
-of strings located in :py:mod:`nameparser.config`. You can adjust
-these predefined sets to help fine tune the parser for your dataset.
-
-Changing the Parser Constants
------------------------------
-
-There are a few ways to adjust the parser configuration depending on your
-needs. The config is available in two places.
-
-The first is via ``from nameparser.config import CONSTANTS``.
-
-.. doctest::
-
- >>> from nameparser.config import CONSTANTS
- >>> CONSTANTS
- <Constants() instance>
-
-The other is the ``C`` attribute of a ``HumanName`` instance, e.g.
-``hn.C``.
-
... 1054 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-nameparser.git
More information about the Python-modules-commits
mailing list