{
    "info": {
        "author": "",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: Apache Software License",
            "Operating System :: MacOS",
            "Operating System :: Microsoft :: Windows",
            "Operating System :: POSIX :: Linux",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Topic :: Scientific/Engineering :: Bio-Informatics",
            "Topic :: Software Development :: Libraries",
            "Topic :: Software Development :: Libraries :: Python Modules"
        ],
        "description": "# :construction: PFB Python SDK :construction:\n\nPython SDK to create, explore and modify PFB (Portable Format for Biomedical Data) files.\n\n## PFB Schema\n\n[![metadata][1]][1]\n\n## Installation\n\n* From PyPI:\n\n```bash\npip install pypfb[gen3]\n```\n\n(The optional `gen3` dependencies add the ability to convert a Gen3 data dictionary into\na PFB file.)\n\n* From source code:\n\n```bash\npipenv install\n```\n\n(Also add `--dev` for development.)\n\n\n## Usage\n\n### Main\n\n    Usage: pfb [OPTIONS] COMMAND [ARGS]...\n\n      PFB: Portable Format for Biomedical Data.\n\n    Commands:\n      add     Add records into a PFB file.\n      from    Generate PFB from other data formats.\n      make    Make a blank record for add.\n      rename  Rename different parts of schema.\n      show    Show different parts of a PFB file.\n      to      Convert PFB into other data formats.\n\n### Show different parts of PFB\n\n    Usage: pfb show [OPTIONS] COMMAND [ARGS]...\n\n      Show records of the PFB file.\n\n      Specify a sub-command to show other information.\n\n    Options:\n      -i, --input FILENAME  The PFB file.  [default: <stdin>]\n      -n, --limit INTEGER   How many records to show, ignored for sub-commands.\n                            [default: no limit]\n\n    Commands:\n      metadata  Show the metadata of the PFB file.\n      nodes     Show all the node names in the PFB file.\n      schema    Show the schema of the PFB file.\n\n### Convert Gen3 data dictionary into PFB schema\n\n    Usage: pfb from [PARENT OPTIONS] dict DICTIONARY\n\n      Convert Gen3 data DICTIONARY into a PFB file.\n\n      If DICTIONARY is a HTTP URL, it will be downloaded and parsed as JSON; or\n      it will be treated as a local path to a directory containing YAML files.\n\n    Parent Options:\n      -o, --output FILENAME  The output PFB file.  [default: <stdout>]\n\n### Convert JSON for corresponding datadictionary to PFB\n\n    Usage: pfb from [PARENT OPTIONS] json [OPTIONS] [PATH]\n\n      Convert JSON files under PATH into a PFB file.\n\n    Parent Options:\n      -o, --output FILENAME  The output PFB file.  [default: <stdout>]\n\n    Options:\n      -s, --schema FILENAME  The PFB file to load the schema from.  [required]\n      --program TEXT         Name of the program.  [required]\n      --project TEXT         Name of the project.  [required]\n\n### Make new blank record\n\n    Usage: pfb make [OPTIONS] NAME\n\n      Make a blank record according to given NODE schema in the PFB file.\n\n    Options:\n      -i, --input PFB  Read schema from this PFB file.  [default: <stdin>]\n\n### Add new record to PFB\n\n    Usage: pfb add [OPTIONS] PFB\n\n      Add records from a minified JSON file to the PFB file.\n\n    Options:\n      -i, --input JSON  The JSON file to add.  [default: <stdin>]\n\n### Rename different parts of PFB (schema evolution)\n\n    Usage: pfb rename [OPTIONS] COMMAND [ARGS]...\n\n      Rename different parts of schema.\n\n    Options:\n      -i, --input FILENAME   Source PFB file.  [default: <stdin>]\n      -o, --output FILENAME  Destination PFB file.  [default: <stdout>]\n\n    Commands:\n      enum  Rename enum.\n      node  Rename node.\n      type  Rename type (not implemented).\n\n### Rename node\n\n    Usage: pfb rename [PARENT OPTIONS] node [OPTIONS] OLD NEW\n\n      Rename node from OLD to NEW.\n\n### Rename enum\n\n    Usage: pfb rename [PARENT OPTIONS] enum [OPTIONS] FIELD OLD NEW\n\n      Rename enum of FIELD from OLD to NEW.\n\n### Convert PFB into Neptune (bulk load format for Gremlin)\n\n    Usage: pfb to [PARENT OPTIONS] gremlin [OPTIONS] [OUTPUT]\n\n      Convert PFB into CSV files under OUTPUT for Neptune bulk load (Gremlin).\n\n      The default OUTPUT is ./gremlin/.\n\n    Options:\n      --gzip / --no-gzip  Whether gzip the output.  [default: yes]\n\n\n## Examples\n\n    pfb from dict http://s3.amazonaws.com/dictionary-artifacts/kf-dictionary/1.1.0/schema.json > ./tests/schema/kf.avro\n    \n    pfb from json ./tests/data -s ./tests/schema/kf.avro --program DEV --project test > tests/pfb-data/test.avro\n\n    cat tests/pfb-data/test.avro | pfb rename node slide slide_test > tests/pfb-data/rename_test.avro\n    \n    cat tests/pfb-data/test.avro | pfb rename enum state validated validated_test > tests/pfb-data/rename_test.avro\n    \n    cat tests/pfb-data/test.avro | pfb show -n 1 | jq\n\n    cat tests/pfb-data/test.avro | pfb show --schema | jq\n\n    cat tests/pfb-data/test.avro | pfb to gremlin ./output/\n\n\n  [1]: ./doc/metadata.svg",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/uc-cdis/pypfb",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "pypfb",
        "package_url": "https://pypi.org/project/pypfb/",
        "platform": "",
        "project_url": "https://pypi.org/project/pypfb/",
        "project_urls": {
            "Homepage": "https://github.com/uc-cdis/pypfb"
        },
        "release_url": "https://pypi.org/project/pypfb/0.2.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Python SDK for PFB format",
        "version": "0.2.0"
    },
    "last_serial": 5678153,
    "releases": {
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2c0388d9743fe76ca392adddb7acede7",
                    "sha256": "fc0632b3f87e62a0ec5ff70e35580cc596c1fff4d60b1c19b1c7e1a0204a0966"
                },
                "downloads": -1,
                "filename": "pypfb-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "2c0388d9743fe76ca392adddb7acede7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 21060,
                "upload_time": "2019-08-14T16:44:20",
                "url": "https://files.pythonhosted.org/packages/71/22/b9267d39672cd6cb9d28f0bf098f9a846882352d6d77619e23425b028eb6/pypfb-0.2.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "2c0388d9743fe76ca392adddb7acede7",
                "sha256": "fc0632b3f87e62a0ec5ff70e35580cc596c1fff4d60b1c19b1c7e1a0204a0966"
            },
            "downloads": -1,
            "filename": "pypfb-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2c0388d9743fe76ca392adddb7acede7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 21060,
            "upload_time": "2019-08-14T16:44:20",
            "url": "https://files.pythonhosted.org/packages/71/22/b9267d39672cd6cb9d28f0bf098f9a846882352d6d77619e23425b028eb6/pypfb-0.2.0.tar.gz"
        }
    ]
}