From 67f8f69139b599d75bb367948656c1aa6173e2d2 Mon Sep 17 00:00:00 2001 From: Richard Berger Date: Wed, 4 May 2016 11:33:18 -0400 Subject: [PATCH] Some restructuring to follow common Python practices --- .gitignore | 2 ++ bin/txt2html | 1 - bin/txt2rst | 1 - lammpsdoc/__init__.py | 0 {src => lammpsdoc}/lammps_filters.py | 0 {src => lammpsdoc}/txt2html.py | 5 ++++- {src => lammpsdoc}/txt2rst.py | 9 ++++++--- setup.py | 17 +++++++++++++++++ {src => tests}/test_lammps_filters.py | 2 +- {src => tests}/test_txt2html.py | 2 +- {src => tests}/test_txt2rst.py | 2 +- 11 files changed, 32 insertions(+), 9 deletions(-) create mode 100644 .gitignore delete mode 120000 bin/txt2html delete mode 120000 bin/txt2rst create mode 100644 lammpsdoc/__init__.py rename {src => lammpsdoc}/lammps_filters.py (100%) rename {src => lammpsdoc}/txt2html.py (99%) rename {src => lammpsdoc}/txt2rst.py (98%) create mode 100644 setup.py rename {src => tests}/test_lammps_filters.py (98%) rename {src => tests}/test_txt2html.py (99%) rename {src => tests}/test_txt2rst.py (99%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3fafd07 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +__pycache__ +*.egg-info diff --git a/bin/txt2html b/bin/txt2html deleted file mode 120000 index 681fca5..0000000 --- a/bin/txt2html +++ /dev/null @@ -1 +0,0 @@ -../src/txt2html.py \ No newline at end of file diff --git a/bin/txt2rst b/bin/txt2rst deleted file mode 120000 index 0047caa..0000000 --- a/bin/txt2rst +++ /dev/null @@ -1 +0,0 @@ -../src/txt2rst.py \ No newline at end of file diff --git a/lammpsdoc/__init__.py b/lammpsdoc/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/lammps_filters.py b/lammpsdoc/lammps_filters.py similarity index 100% rename from src/lammps_filters.py rename to lammpsdoc/lammps_filters.py diff --git a/src/txt2html.py b/lammpsdoc/txt2html.py similarity index 99% rename from src/txt2html.py rename to lammpsdoc/txt2html.py index e1da64c..ddb1b19 100755 --- a/src/txt2html.py +++ b/lammpsdoc/txt2html.py @@ -689,6 +689,9 @@ class Txt2HtmlConverter(TxtConverter): filename, ext = os.path.splitext(path) return filename + ".html" -if __name__ == "__main__": +def main(): app = Txt2HtmlConverter() app.run() + +if __name__ == "__main__": + main() diff --git a/src/txt2rst.py b/lammpsdoc/txt2rst.py similarity index 98% rename from src/txt2rst.py rename to lammpsdoc/txt2rst.py index 90a86db..ba38640 100755 --- a/src/txt2rst.py +++ b/lammpsdoc/txt2rst.py @@ -21,8 +21,8 @@ import os import re import argparse -import lammps_filters -from txt2html import Markup, Formatting, TxtParser, TxtConverter +from lammpsdoc import lammps_filters +from lammpsdoc.txt2html import Markup, Formatting, TxtParser, TxtConverter class RSTMarkup(Markup): def __init__(self): @@ -336,6 +336,9 @@ class Txt2RstConverter(TxtConverter): filename, ext = os.path.splitext(path) return filename + ".rst" -if __name__ == "__main__": +def main(): app = Txt2RstConverter() app.run() + +if __name__ == "__main__": + main() diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..b8a6a1a --- /dev/null +++ b/setup.py @@ -0,0 +1,17 @@ +from setuptools import setup + +setup(name='LAMMPS Documentation Utilities', + version='2.0.0', + description='Utilities to convert existing LAMMPS documentation text files into ReStructured Text', + url='https://github.com/rbberger/lammps-doc-utils', + author='Richard Berger', + author_email='richard.berger@outlook.com', + license='GPL', + packages=['lammpsdoc'], + test_suite='nose.collector', + tests_require=['nose'], + entry_points = { + "console_scripts": ['txt2html = lammpsdoc.txt2html:main', + 'txt2rst = lammpsdoc.txt2rst:main'] + }, +) diff --git a/src/test_lammps_filters.py b/tests/test_lammps_filters.py similarity index 98% rename from src/test_lammps_filters.py rename to tests/test_lammps_filters.py index e402d59..6c25c23 100644 --- a/src/test_lammps_filters.py +++ b/tests/test_lammps_filters.py @@ -16,7 +16,7 @@ # along with this program. If not, see . import unittest -import txt2rst +from lammpsdoc import txt2rst class TestStructuralFilters(unittest.TestCase): def setUp(self): diff --git a/src/test_txt2html.py b/tests/test_txt2html.py similarity index 99% rename from src/test_txt2html.py rename to tests/test_txt2html.py index 24cebc9..d806a29 100644 --- a/src/test_txt2html.py +++ b/tests/test_txt2html.py @@ -19,7 +19,7 @@ import unittest import tempfile import io import os -import txt2html +from lammpsdoc import txt2html class TestBasicFormatting(unittest.TestCase): def setUp(self): diff --git a/src/test_txt2rst.py b/tests/test_txt2rst.py similarity index 99% rename from src/test_txt2rst.py rename to tests/test_txt2rst.py index 34b3d98..1be59ac 100644 --- a/src/test_txt2rst.py +++ b/tests/test_txt2rst.py @@ -18,7 +18,7 @@ import io import tempfile import unittest -import txt2rst +from lammpsdoc import txt2rst class TestBasicFormatting(unittest.TestCase): def setUp(self):