Moved the metadata into setup.cfg.

Added pyproject.toml.
Renamed console_scripts because their names are too generic to have this package installed into system.
Fixed the names of the commands within the docstrings.
Versions are now fetched from git tags.
Excluded the dirs that are not meant to go into wheels, like `examples/`.
Added the things jayvdb has suggested into the metadata.

Co-authored-by: John Vandenberg <[email protected]>
Signed-off-by: KOLANICH <[email protected]>

Author: 2 people

.circleci/config.yml

@@ -22,10 +22,18 @@ commands:
           pyenv global << parameters.python_version >>
           python --version
 
+  update_packaging_tools:
+    steps:
+      - run: |
+          python -m pip install --upgrade pip
+      - run: |
+          python -m pip install --upgrade setuptools wheel setuptools_scm build
+
   install_run_tests:
     steps:
       - run: |
-          python setup.py install
+          python -m build -nwx .
+          python -m pip install --upgrade ./dist/*.whl
           python -m pip install pytest
       - run: pytest
 
@@ -38,6 +46,7 @@ jobs:
     - checkout
     - mac_install_python:
         python_version: "3.7.10"
+    - update_packaging_tools
     - install_run_tests
 
 
@@ -49,6 +58,7 @@ jobs:
     - checkout
     - mac_install_python:
         python_version: "3.8.10"
+    - update_packaging_tools
     - install_run_tests
 
   mac_python_3_9:
@@ -59,6 +69,7 @@ jobs:
     - checkout
     - mac_install_python:
         python_version: "3.9.5"
+    - update_packaging_tools
     - install_run_tests
 
   mac_python_3_10:
@@ -69,34 +80,39 @@ jobs:
     - checkout
     - mac_install_python:
         python_version: "3.10.6"
+    - update_packaging_tools
     - install_run_tests
 
   linux_python_3_7:
     docker:
       - image: python:3.7
     steps:
     - checkout
+    - update_packaging_tools
     - install_run_tests
 
   linux_python_3_8:
     docker:
       - image: python:3.8
     steps:
     - checkout
+    - update_packaging_tools
     - install_run_tests
 
   linux_python_3_9:
     docker:
       - image: python:3.9
     steps:
     - checkout
+    - update_packaging_tools
     - install_run_tests
 
   linux_python_3_10:
     docker:
       - image: python:3.10
     steps:
     - checkout
+    - update_packaging_tools
     - install_run_tests
 
 workflows:

README.md

@@ -50,31 +50,31 @@ This is the result of an initial GSoC contribution by @[ah450](https://github.co
 ## Command-line usage:
 
 1. **PARSER** (for parsing any format):
-* Use `parser --file <filename>` where `<filename>` is the location of the file.              
-Try running: `parser --file data/SPDXRdfExample.rdf`.
+* Use `pyspdxtools_parser --file <filename>` where `<filename>` is the location of the file.              
+Try running: `pyspdxtools_parser --file data/SPDXRdfExample.rdf`.
 
-* Or you can use `parser` only, and it will automatically prompt/ask for `filename`.
+* Or you can use `pyspdxtools_parser` only, and it will automatically prompt/ask for `filename`.
 
-* For help use `parser --help`
+* For help use `pyspdxtools_parser --help`
 
 
 2. **CONVERTOR** (for converting one format to another):
 * If I/O formats are known:
 
-    * Use `convertor --infile/-i <input_file> --outfile/-o <output_file>` where `<input_file>` is the location of the file to be converted
+    * Use `pyspdxtools_convertor --infile/-i <input_file> --outfile/-o <output_file>` where `<input_file>` is the location of the file to be converted
     (Note: only RDF and Tag formatted supported) and `<output_file>` is the location of the output file.  
-    Try running : `convertor --infile data/SPDXRdfExample.rdf --outfile output.json` 
+    Try running : `pyspdxtools_convertor --infile data/SPDXRdfExample.rdf --outfile output.json` 
 
 * If I/O formats are not known:
 
-    * Use `convertor --from/-f <input_format> <input_file> --to/-t <output_format> <output_file>` where `<input_format>` is the manually entered format of the input file (can be either rdf or tag)
+    * Use `pyspdxtools_convertor --from/-f <input_format> <input_file> --to/-t <output_format> <output_file>` where `<input_format>` is the manually entered format of the input file (can be either rdf or tag)
     and `<out_format>` (can be tag, rdf, json, yaml, xml) is the manually entered format of the output file. 
-    Try running : `convertor --from tag data/SPDXTagExample.in --to yaml output.out` 
+    Try running : `pyspdxtools_convertor --from tag data/SPDXTagExample.in --to yaml output.out` 
 
 * If one of the formats is known and the other is not, you can use a mixture of the above two points.  
-Example: `convertor -f rdf data/SPDXRdfExample.xyz -o output.xml`
+Example: `pyspdxtools_convertor -f rdf data/SPDXRdfExample.xyz -o output.xml`
 
-* For help use `convertor --help`
+* For help use `pyspdxtools_convertor --help`
 
 
 # Installation

appveyor.yml

@@ -10,8 +10,9 @@ environment:
 
 install:
   - "%PYTHON_EXE% --version"
-  - "%PYTHON_EXE% setup.py install"
-  - "%PYTHON_EXE% -m pip install pytest"
+  - "%PYTHON_EXE% -m pip install --upgrade pip"
+  - "%PYTHON_EXE% -m pip install --upgrade setuptools setuptools_scm wheel build pytest"
+  - "%PYTHON_EXE% -m pip install --upgrade -e ."
 
 build: off
 

pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = ["setuptools>=44", "wheel", "setuptools_scm[toml]>=3.4.3"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+git_describe_command = ["git", "describe", "--dirty", "--tags", "--long", "--match",  "v[0-9]*"]  # `python3.6` tag falsely matches to the default one, clrearly a bug in setuptools_scm

setup.cfg

@@ -1,5 +1,46 @@
 [metadata]
+name = spdx-tools
+author = Ahmed H. Ismail
+author_email = [email protected]
+maintainer = Philippe Ombredanne, SPDX group at the Linux Foundation and others
+maintainer_email = [email protected]
+license = Apache-2.0
 license_file = LICENSE
+description = SPDX parser and tools.
+url = https://github.com/spdx/tools-python
+long_description = file: README.md
+long_description_content_type = text/markdown
+classifiers =
+    Intended Audience :: Developers
+    Intended Audience :: System Administrators
+    License :: OSI Approved :: Apache Software License
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
+
+[options]
+zip_safe = False  # because of the uses of __file__: https://github.com/spdx/tools-python/issues/257
+packages = find:
+install_requires = ply; rdflib; click; pyyaml; xmltodict
+include_package_data = True
+python_requires = >=3.6
+test_suite = setup.test_suite
+
+[options.extras_require]
+test = pytest
+
+[options.packages.find]
+include = 
+    spdx
+    spdx.*
+
+[options.entry_points]
+console_scripts =
+    pyspdxtools_convertor = spdx.cli_tools.convertor:main
+    pyspdxtools_parser = spdx.cli_tools.parser:main
 
 [aliases]
 release = clean --all sdist --formats=gztar bdist_wheel

setup.py

@@ -1,63 +1,6 @@
-#!/usr/bin/env python
-# -*- encoding: utf-8 -*-
+#!/usr/bin/python
 
 from setuptools import setup
-import unittest
 
-
-def test_suite():
-    return unittest.TestLoader().discover('tests', pattern='test_*.py')
-
-
-with open('README.md', 'r') as fh:
-    long_description = fh.read()
-
-setup(
-    name='spdx-tools',
-    version='0.7.0a3',
-    description='SPDX parser and tools.',
-    long_description=long_description,
-    long_description_content_type='text/markdown',
-    packages=[
-        'spdx',
-        'spdx.parsers',
-        'spdx.parsers.lexers',
-        'spdx.writers',
-        'examples',
-    ],
-    include_package_data=True,
-    zip_safe=False,
-    test_suite='setup.test_suite',
-    install_requires=[
-        'ply',
-        'rdflib',
-        'click',
-        'pyyaml',
-        'xmltodict',
-    ],
-    tests_require=[
-        'pytest',
-    ],
-    python_requires='>=3.6',
-    entry_points={
-        'console_scripts': [
-            'convertor = spdx.cli_tools.convertor:main',
-            'parser = spdx.cli_tools.parser:main',
-        ],
-    },
-
-    author='Ahmed H. Ismail',
-    author_email='[email protected]',
-    maintainer='Philippe Ombredanne, SPDX group at the Linux Foundation and others',
-    maintainer_email='[email protected]',
-    url='https://github.com/spdx/tools-python',
-    license='Apache-2.0',
-    classifiers=[
-        'Intended Audience :: Developers',
-        'License :: OSI Approved :: Apache Software License',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
-    ]
-)
+if __name__ == "__main__":
+    setup()

spdx/cli_tools/convertor.py

@@ -26,13 +26,13 @@ def determine_infile_and_outfile(infile, outfile, src, from_, to):
     if infile is not None and outfile is not None:
         """
         when the CLI is of given format:
-        ' convertor ---infile <input_file> ---outfile <output_file>.
+        ' pyspdxtools_convertor ---infile <input_file> ---outfile <output_file>.
         """
         return infile, outfile
 
     elif infile is None and outfile is None and len(src) == 2:
         """
-        ' convertor -f/--from <type> <input_file> -t/--to <type> <output_file>.
+        ' pyspdxtools_convertor -f/--from <type> <input_file> -t/--to <type> <output_file>.
         """
         infile = src[0]
         outfile = src[1]
@@ -47,7 +47,7 @@ def determine_infile_and_outfile(infile, outfile, src, from_, to):
 
     elif infile is None and outfile is not None:
         """
-        ' convertor -f/--from <type> <input_file> --outfile <output_file> '
+        ' pyspdxtools_convertor -f/--from <type> <input_file> --outfile <output_file> '
         """
         infile = src[0]
         if from_ is not None:
@@ -57,7 +57,7 @@ def determine_infile_and_outfile(infile, outfile, src, from_, to):
 
     elif infile is not None and outfile is None:
         """
-        ' convertor --infile <input_file> -t/--to <type> <output_file>'
+        ' pyspdxtools_convertor --infile <input_file> -t/--to <type> <output_file>'
         """
         outfile = src[0]
         if to is not None:
@@ -88,7 +88,7 @@ def main(infile, outfile, src, from_, to, force):
     """
     CLI-TOOL for converting a RDF or TAG file to RDF, JSON, YAML, TAG or XML format.
 
-    To use : run 'convertor -f <from_TYPE> <input file> -t <to_TYPE> <output_file>' command on terminal or use ' convertor --infile <input file name> --outfile <output file name> '
+    To use : run 'pyspdxtools_convertor -f <from_TYPE> <input file> -t <to_TYPE> <output_file>' command on terminal or use ' pyspdxtools_convertor --infile <input file name> --outfile <output file name> '
 
     """
     try:

spdx/cli_tools/parser.py

@@ -25,7 +25,7 @@ def main(file, force):
     """
     COMMAND-LINE TOOL for parsing file of RDF, XML, JSON, YAML and XML format.
 
-    To use : run `parser` using terminal or run `parser --file <file name>`
+    To use : run `pyspdxtools_parser` using terminal or run `pyspdxtools_parser --file <file name>`
 
     """
     doc, errors = parse_file(file)