Metadata-Version: 2.1
Name: spdx-tools
Version: 0.6.1
Summary: SPDX parser and tools.
Home-page: https://github.com/spdx/tools-python
Author: Ahmed H. Ismail
Author-email: ahm3d.hisham@gmail.com
Maintainer: Philippe Ombredanne, SPDX group at the Linux Foundation and others
Maintainer-email: pombredanne@gmail.com
License: Apache-2.0
Description: # Python SPDX Library to parse, validate and create SPDX documents
        
        | Linux | macOS | Windows |
        | :---- | :------ | :---- |
        [ ![Linux build status][1]][2] | [![macOS build status][3]][4] | [![Windows build status][5]][6] |
        
        [1]: https://travis-ci.org/spdx/tools-python.svg?branch=master
        [2]: https://travis-ci.org/spdx/tools-python
        [3]: https://circleci.com/gh/spdx/tools-python/tree/master.svg?style=shield&circle-token=36cca2dfa3639886fc34e22d92495a6773bdae6d
        [4]: https://circleci.com/gh/spdx/tools-python/tree/master
        [5]: https://ci.appveyor.com/api/projects/status/0bf9glha2yg9x8ef/branch/master?svg=true
        [6]: https://ci.appveyor.com/project/spdx/tools-python/branch/master
        
        This library implements an SPDX tag/value and RDF parser, validator and handler in Python.
        This is the result of an initial GSoC contribution by @[ah450](https://github.com/ah450) (or https://github.com/a-h-i) and 
        is maintained by a community of SPDX adopters and enthusiasts.
        
        Home: https://github.com/spdx/tools-python
        
        Issues: https://github.com/spdx/tools-python/issues
        
        Pypi: https://pypi.python.org/pypi/spdx-tools
        
        
        # License
        
        [Apache-2.0](LICENSE)
        
        
        # Features
        
        * API to create and manipulate SPDX documents.
        * Parse and create Tag/Value, RDF, JSON, YAML, XML format SPDX files
        
        
        # TODOs
        
        * Update to full SPDX v2.1
        * Add to full license expression support
        
        
        # How to use
        
        Example tag/value parsing usage:
        ```Python
            from spdx.parsers.tagvalue import Parser
            from spdx.parsers.tagvaluebuilders import Builder
            from spdx.parsers.loggers import StandardLogger
            p = Parser(Builder(), StandardLogger())
            p.build()
            # data is a string containing the SPDX file.
            document, error = p.parse(data)
        
        ```
        
        The `examples` directory contains several code samples. Here some of them:
        
        * `parse_tv.py` is an example tag/value parsing usage.
          Try running `python parse_tv.py ../data/SPDXSimpleTag.tag `
        
        * `write_tv.py` provides an example of writing tag/value files.
          Run `python write_tv.py sample.tag` to test it.
        
        * `pp_tv.py` demonstrates how to pretty-print a tag/value file.
           To test it run `python pp_tv.py ../data/SPDXTagExample.tag pretty.tag`.
        
        * `parse_rdf.py` demonstrates how to parse an RDF file and print out document 
           information. To test it run `python parse_rdf.py ../data/SPDXRdfExample.rdf`
        
        * `rdf_to_tv.py` demonstrates how to convert an RDF file to a tag/value one.
           To test it run `python rdf_to_tv.py ../data/SPDXRdfExample.rdf converted.tag`
        
        * `pp_rdf.py` demonstrates how to pretty-print an RDF file, to test it run 
          `python pp_rdf.py ../data/SPDXRdfExample.rdf pretty.rdf`
        
        
        # Installation
        
        As always you should work in a virtualenv or venv.  You can install a local clone
        of this repo with `yourenv/bin/pip install .` or install from PyPI with
        `yourenv/bin/pip install spdx-tools`.  Note that on Windows it would be `Scripts`
        instead of `bin`.
        
        
        # How to run tests
        
        From the project root directory run: `python setup.py test`.
        You can use another test runner such as pytest or nose at your preference.
        
        
        # Development process
        
        We use the GitHub flow that is described here: https://guides.github.com/introduction/flow/
        
        So, whenever we have to make some changes to the code, we should follow these steps:
        1. Create a new branch:
            `git checkout -b fix-or-improve-something`
        2. Make some changes and the first commit(s) to the branch: 
            `git commit -m 'What changes we did'`
        3. Push the branch to GitHub:
            `git push origin fix-or-improve-something`
        4. Make a pull request on GitHub.
        5. Continue making more changes and commits on the branch, with `git commit` and `git push`.
        6. When done, write a comment on the PR asking for a code review.
        7. Some other developer will review your changes and accept your PR. The merge should be done with `rebase`, if possible, or with `squash`.
        8. The temporary branch on GitHub should be deleted (there is a button for deleting it).
        9. Delete the local branch as well:
            ```
            git checkout master
            git pull -p
            git branch -a
            git branch -d fix-or-improve-something
            ```
        
        Besides this, another requirement is that every change should be made to fix or close an issue: https://guides.github.com/features/issues/
        If there is no issue for the changes that you want to make, create first an issue about it that describes what needs to be done, assign it to yourself, and then start working for closing it.
        
        
        # Dependencies
        
        * PLY : https://pypi.python.org/pypi/ply/ used for parsing.
        * rdflib : https://pypi.python.org/pypi/rdflib/ for handling RDF. 
        * PyYAML: https://pypi.org/project/PyYAML/ for handling YAML.
        * xmltodict: https://pypi.org/project/xmltodict/ for handling XML.
        
        
        # Support
        
        * Submit issues, questions or feedback at: https://github.com/spdx/tools-python/issues
        * Join the dicussion on https://lists.spdx.org/mailman/listinfo/spdx-tech and 
          https://spdx.org/WorkgroupTechnical
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2.7
Description-Content-Type: text/markdown
