diff --git a/README.md b/README.md index c3af4ce..f743c69 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,19 @@ Automagically process the specification ## Installing dependencies ``` -❯ python3 -m pip install -r requirements.txt +❯ python3 setup.py install +``` + +or: + +``` +❯ pip install git+https://github.com/spdx/spec-parser ``` ## Usage ``` -❯ python main.py -h +❯ spec-parser -h usage: spec-parser [-h] [--gen-md] [--gen-refs] [--gen-rdf] [--use-table] [--out-dir OUT_DIR] spec_dir SPDX specification parser diff --git a/docs/md_docs/getting_started.md b/docs/md_docs/getting_started.md index b255405..bae6c13 100755 --- a/docs/md_docs/getting_started.md +++ b/docs/md_docs/getting_started.md @@ -16,13 +16,19 @@ ## Installing dependencies ``` -❯ python3 -m pip install -r requirements.txt +❯ python3 setup.py install +``` + +or: + +``` +❯ pip install git+https://github.com/spdx/spec-parser ``` ## Usage ``` -❯ python main.py -h +❯ spec-parser -h usage: spec-parser [-h] [--gen-md] [--gen-refs] [--gen-rdf] [--use-table] [--out-dir OUT_DIR] spec_dir SPDX specification parser diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..7686037 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,22 @@ +[build-system] +build-backend = "setuptools.build_meta" +requires = ["setuptools", "wheel"] + +[project] +name = "spec_parser" +version = "0.0.4" +dependencies = [ + "isodate", + "Jinja2", + "MarkupSafe", + "pyparsing", + "rdflib", + "six", + "sly", +] + +[project.scripts] +spec-parser = "spec_parser.__main__:main" + +[tool.setuptools.package-data] +"spec_parser.templates" = ["*.j2"] diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index fea80c5..0000000 --- a/requirements.txt +++ /dev/null @@ -1,7 +0,0 @@ -isodate==0.6.0 -Jinja2==3.1.2 -MarkupSafe==2.1.3 -pyparsing==2.4.7 -rdflib==6.0.0 -six==1.16.0 -sly==0.4 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..8bf1ba9 --- /dev/null +++ b/setup.py @@ -0,0 +1,2 @@ +from setuptools import setup +setup() diff --git a/main.py b/spec_parser/__main__.py similarity index 98% rename from main.py rename to spec_parser/__main__.py index 3cd5016..c78a2cc 100644 --- a/main.py +++ b/spec_parser/__main__.py @@ -47,9 +47,7 @@ def get_args(): return args - -if __name__ == "__main__": - +def main(): args = get_args() if not os.path.isdir(args.spec_dir): @@ -69,3 +67,6 @@ def get_args(): spec.gen_md() if args.gen_rdf: spec.gen_rdf() + +if __name__ == "__main__": + main() diff --git a/spec_parser/templates/default/class.md.j2 b/spec_parser/templates/class.md.j2 similarity index 100% rename from spec_parser/templates/default/class.md.j2 rename to spec_parser/templates/class.md.j2 diff --git a/spec_parser/templates/default/property.md.j2 b/spec_parser/templates/property.md.j2 similarity index 100% rename from spec_parser/templates/default/property.md.j2 rename to spec_parser/templates/property.md.j2 diff --git a/spec_parser/templates/default/vocab.md.j2 b/spec_parser/templates/vocab.md.j2 similarity index 100% rename from spec_parser/templates/default/vocab.md.j2 rename to spec_parser/templates/vocab.md.j2 diff --git a/spec_parser/utils.py b/spec_parser/utils.py index cf2756d..4fbf3d2 100644 --- a/spec_parser/utils.py +++ b/spec_parser/utils.py @@ -118,7 +118,7 @@ def gen_md(self) -> None: self.logger.warning(f"Overwriting out_dir `{self.args['out_dir']}`") env = Environment( - loader=PackageLoader("spec_parser", package_path="templates/default"), + loader=PackageLoader("spec_parser", package_path="templates"), autoescape=False )