{
    "info": {
        "author": "UCL Research IT Services",
        "author_email": "rc-softdev@ucl.ac.uk",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "Intended Audience :: Education",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
            "Operating System :: MacOS",
            "Operating System :: Microsoft :: Windows",
            "Operating System :: POSIX",
            "Operating System :: Unix",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 3",
            "Topic :: Software Development :: Libraries :: Python Modules",
            "Topic :: Utilities"
        ],
        "description": "pyoracc\n=======\n\n[![Build Status](https://travis-ci.org/oracc/pyoracc.svg?branch=master)](https://travis-ci.org/oracc/pyoracc) \n[![Maintainability](https://api.codeclimate.com/v1/badges/7244ac087b45146c5e3e/maintainability)](https://codeclimate.com/github/cdli-gh/pyoracc/maintainability)\n[![codecov](https://codecov.io/gh/oracc/pyoracc/branch/master/graph/badge.svg)](https://codecov.io/gh/oracc/pyoracc)\n\nPython tools for working with ORACC/C-ATF files\n\nDepends on PLY, Mako and Pytest\n\n# Installation\n\nIf you don't use `pip`, you're missing out.\nHere are [installation instructions](https://pip.pypa.io/en/stable/installing/).\n\nSimply run:\n\n```bash\n    $ cd pyoracc\n    $ git pull origin master\n    $ pip install .\n```\n\nOr you can just do\n\n    $ pip install git+git://github.com/cdli-gh/pyoracc.git \n\nOr you can also do\n\n    $ pip install git+https://github.com/cdli-gh/pyoracc.git \n\n\n# Upgrading\n\nIf you already have installed it and want to upgrade the tool:\n\n```bash\n    $ cd pyoracc\n    $ git pull origin master\n    $ pip install . --upgrade\n```\n\nOr you can just do\n\n    $ pip install git+git://github.com/cdli-gh/pyoracc.git --upgrade\n\nOr you can also do\n\n    $ pip install git+https://github.com/cdli-gh/pyoracc.git --upgrade\n\n\n# Usage\n\nTo use it:\n\n    $ pyoracc --help\n\n*Only files with the .atf extension can be processed.  *\n\nTo run it on file:\n\n    $ pyoracc -i ./pyoracc/test/data/cdli_atf_20180104.atf -f cdli\n\nFor a fresh copy of CDLI ATF, download the data bundle here : https://github.com/cdli-gh/data/blob/master/cdliatf_unblocked.atf\n\nTo run it on oracc file:\n\n    $ pyoracc -i ./pyoracc/test/data/cdli_atf_20180104.atf -f oracc\n\nTo run it on folder:\n\n    $ pyoracc -i ./pyoracc/test/data -f cdli\n\nTo see the console messages of the tool, use --verbose switch\n\n    $ pyoracc -i ./pyoracc/test/data -f cdli --verbose\n\nNote that using the verbose option will also create a parselog.txt file, \ncontaining the log output along with displaying it on command line. \nThe verbose output contains the lexical symbols, the parse grammer table\nand the LR parsing table states.\n\nAlso note that, first time usage with any atf format will always display \nthe parse tables irrespective of verbose switch.\n\nIf you don't give arguments, it will prompt for the path and atf file type.  \n\n# Help\n\n```bash\n$ pyoracc --help\nUsage: pyoracc [OPTIONS]\n\n  My Tool does one work, and one work well.\n\nOptions:\n  -i, --input_path PATH      Input the file/folder name.  [required]\n  -f, --atf_type [cdli|atf]  Input the atf file type.  [required]\n  -v, --verbose              Enables verbose mode\n  --version                  Show the version and exit.\n  --help                     Show this message and exit.\n\n```\n\n## Internal Dev Usage\n\n### Development Guideline\n\n* ORACC atf based changes will go in pyoracc/atf/oracc\n* CDLI atf based changes will go in pyoracc/atf/cdli\n* Common atf based changes will go in pyoracc/atf/common\n\n### To run on directory\n\n    $ python  -m pyoracc.model.corpus ./pyoracc/test/data  cdli\n\n### To run on individual file\n\n    $ python -m pyoracc.atf.common.atffile ./pyoracc/test/data/cdli_atf_20180104.atf cdli True\n\n## Running Tests\n\nBefore running pytest and coverage, install [py.test](https://docs.pytest.org/en/latest/getting-started.html) and [pytest-cov](https://pypi.org/project/pytest-cov/).\n\n    $ py.test --cov=pyoracc --cov-report xml --cov-report html --cov-report annotate --runslow\n\nBefore running pycodestyle, install [pycodestyle](https://pypi.org/project/pycodestyle/).\n\n    $ pycodestyle\n\n## API Consumption\n\n```python\nfrom pyoracc.atf.common.atffile import file_process\nfile_process(pathname, atftype, verbose)\n```\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "https://github.com/ucl/pyoracc/archive/master.tar.gz",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/ucl/pyoracc",
        "keywords": "oracc cdli atf cuneiform parser",
        "license": "GPLv3",
        "maintainer": "",
        "maintainer_email": "",
        "name": "pyoracc",
        "package_url": "https://pypi.org/project/pyoracc/",
        "platform": "",
        "project_url": "https://pypi.org/project/pyoracc/",
        "project_urls": {
            "Bug Reports": "https://github.com/oracc/pyoracc/issues",
            "Donating!": "http://oracc.museum.upenn.edu/doc/about/contributing/",
            "Download": "https://github.com/ucl/pyoracc/archive/master.tar.gz",
            "Help!": "http://oracc.museum.upenn.edu/doc/help/index.html",
            "Homepage": "https://github.com/ucl/pyoracc",
            "Source": "https://github.com/oracc/pyoracc/"
        },
        "release_url": "https://pypi.org/project/pyoracc/0.1.0/",
        "requires_dist": [
            "pycodestyle; extra == 'dev'",
            "pytest; extra == 'test'",
            "pytest-cov; extra == 'test'",
            "codecov; extra == 'test'",
            "pycodestyle; extra == 'test'",
            "click",
            "mako",
            "ply",
            "pytest; extra == 'dev'",
            "pytest-cov; extra == 'dev'",
            "codecov; extra == 'dev'"
        ],
        "requires_python": ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, <4",
        "summary": "Python tools for working with ORACC/CDLI ATF files",
        "version": "0.1.0"
    },
    "last_serial": 3833372,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e7fa74ef9174c5cb460735c5c92979af",
                    "sha256": "37ca153eb05b41b4aeb2cbb72825222623b0dd069e6c3137ebb6541925cf95d0"
                },
                "downloads": -1,
                "filename": "pyoracc-0.1.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e7fa74ef9174c5cb460735c5c92979af",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, <4",
                "size": 57869,
                "upload_time": "2018-05-04T06:50:40",
                "url": "https://files.pythonhosted.org/packages/0c/b2/d345c1cf80459280e4ed225a2956bb9fb18ae555dc13c90753fb29ce25dc/pyoracc-0.1.0-py2.py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e7fa74ef9174c5cb460735c5c92979af",
                "sha256": "37ca153eb05b41b4aeb2cbb72825222623b0dd069e6c3137ebb6541925cf95d0"
            },
            "downloads": -1,
            "filename": "pyoracc-0.1.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e7fa74ef9174c5cb460735c5c92979af",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, <4",
            "size": 57869,
            "upload_time": "2018-05-04T06:50:40",
            "url": "https://files.pythonhosted.org/packages/0c/b2/d345c1cf80459280e4ed225a2956bb9fb18ae555dc13c90753fb29ce25dc/pyoracc-0.1.0-py2.py3-none-any.whl"
        }
    ]
}