{
"info": {
"author": "",
"author_email": "",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Environment :: No Input/Output (Daemon)",
"Intended Audience :: Developers",
"Intended Audience :: Education",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: BSD License",
"Natural Language :: English",
"Operating System :: MacOS :: MacOS X",
"Operating System :: Microsoft :: Windows",
"Operating System :: POSIX :: Linux",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Database :: Front-Ends",
"Topic :: Multimedia :: Sound/Audio :: Speech",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator",
"Topic :: Text Processing :: Linguistic",
"Topic :: Utilities"
],
"description": "Tutorial\n========\n\n.. image:: https://travis-ci.org/hltcoe/concrete-python.svg\n :target: https://travis-ci.org/hltcoe/concrete-python\n.. image:: https://ci.appveyor.com/api/projects/status/0346c3lu11vj8xqj?svg=true\n :target: https://ci.appveyor.com/project/cjmay/concrete-python-f3iqf\n\n\nConcrete-python is the Python interface to Concrete_, a\nnatural language processing data format and set of service protocols\nthat work across different operating systems and programming languages\nvia `Apache Thrift`_. Concrete-python contains generated Python\nclasses, utility classes and functions, and scripts. It does not contain the\nThrift schema for Concrete, which can be found in the\n`Concrete GitHub repository`_.\n\nThis document provides a quick tutorial of concrete-python installation and\nusage. For more information, including an API reference and development\ninformation, please see the `online documentation`_.\n\n\n.. contents:: **Table of Contents**\n :local:\n :backlinks: none\n\n\nLicense\n-------\n\nCopyright 2012-2019 Johns Hopkins University HLTCOE. All rights\nreserved. This software is released under the 2-clause BSD license.\nPlease see LICENSE_ for more information.\n\n\nRequirements\n------------\n\nconcrete-python is tested on Python 3.5 and requires the\nThrift Python library, among other Python libraries. These are\ninstalled automatically by ``setup.py`` or ``pip``. The Thrift\ncompiler is *not* required.\n\n**Note**: The accelerated protocol offers a (de)serialization speedup\nof 10x or more; if you would like to use it, ensure a C++ compiler is\navailable on your system before installing concrete-python.\n(If a compiler is not available, concrete-python will fall back to the\nunaccelerated protocol automatically.) If you are on Linux, a suitable\nC++ compiler will be listed as ``g++`` or ``gcc-c++`` in your package\nmanager.\n\nIf you are using macOS Mojave with the Homebrew package manager\n(https://brew.sh), you can install the accelerated protocol using\nthe script ``install-mojave-homebrew-accelerated-thrift.sh``.\n\n\nInstallation\n------------\n\nYou can install Concrete using the ``pip`` package manager::\n\n pip install concrete\n\nor by cloning the repository and running ``setup.py``::\n\n git clone https://github.com/hltcoe/concrete-python.git\n cd concrete-python\n python setup.py install\n\n\nBasic usage\n-----------\n\nHere and in the following sections we make use of an example Concrete\nCommunication file included in the concrete-python source distribution.\nThe *Communication* type represents an article, book, post, Tweet, or\nany other kind of document that we might want to store and analyze.\nCopy it from ``tests/testdata/serif_dog-bites-man.concrete`` if you\nhave the concrete-python source distribution or download it\nseparately here: serif_dog-bites-man.concrete_.\n\nFirst we use the ``concrete-inspect.py`` tool (explained in more detail\nin the following section) to inspect some of the contents of the\nCommunication::\n\n concrete-inspect.py --text serif_dog-bites-man.concrete\n\nThis command prints the text of the Communication to the console. In\nour case the text is a short article formatted in SGML::\n\n \n John Smith, manager of ACM\u00c9 INC, was bit by a dog on March 10th, 2013.\n \n He died!\n \n John's daughter Mary expressed sorrow.\n \n John Smith, manager of ACM\u00c9 INC, was bit by a dog on March 10th, 2013.\n \n He died!\n \n John's daughter Mary expressed sorrow.\n