From 5c0cc8e2f4fd632445079abc7af1b65ca0d3a8e0 Mon Sep 17 00:00:00 2001 From: Loic Guegan Date: Tue, 21 Apr 2020 17:50:05 +0200 Subject: Create package --- .gitignore | 3 + LICENSE | 165 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ bcst | 11 ++++ libs/__init__.py | 0 libs/args.py | 9 +++ libs/resource.py | 23 ++++++++ libs/theme.py | 29 ++++++++++ setup.py | 18 ++++++ src/args.py | 9 --- src/bcst.py | 11 ---- src/resource.py | 23 -------- src/theme.py | 29 ---------- 12 files changed, 258 insertions(+), 72 deletions(-) create mode 100644 LICENSE create mode 100755 bcst create mode 100644 libs/__init__.py create mode 100644 libs/args.py create mode 100644 libs/resource.py create mode 100644 libs/theme.py create mode 100644 setup.py delete mode 100644 src/args.py delete mode 100755 src/bcst.py delete mode 100644 src/resource.py delete mode 100644 src/theme.py diff --git a/.gitignore b/.gitignore index 78ebe7e..67893d5 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,9 @@ ##### Python __pycache__ env +bcst.egg-info +dist +build ##### Emacs \#* diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/bcst b/bcst new file mode 100755 index 0000000..4e3957e --- /dev/null +++ b/bcst @@ -0,0 +1,11 @@ +#!/usr/bin/env python + +from libs.args import args +from libs.resource import Resource +from libs.theme import Theme + + +res=Resource(args.resource) +t=Theme("themes/default",res.json) + +t.deploy(args.destination) diff --git a/libs/__init__.py b/libs/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/libs/args.py b/libs/args.py new file mode 100644 index 0000000..6ae54bf --- /dev/null +++ b/libs/args.py @@ -0,0 +1,9 @@ +#!/usr/bin/env python + +import argparse + +args_parser = argparse.ArgumentParser() +args_parser.add_argument("resource", help="A JSON resource file.") +args_parser.add_argument("destination", help="Start page folder name.") +args = args_parser.parse_args() + diff --git a/libs/resource.py b/libs/resource.py new file mode 100644 index 0000000..f521022 --- /dev/null +++ b/libs/resource.py @@ -0,0 +1,23 @@ +#!/usr/bin/env python + +from os import path +import json, jsonschema + + +class Resource: + def __init__(self, resource): + self.resource=resource + # Read data + try: + with open(resource,'r') as f: + self.data=f.read() + except IOError: + print("Unable to found "+resource) + exit(1) + # Decode data + try: + self.json=json.loads(self.data) + except: + print("Unable to read json from "+resource) + exit(1) + diff --git a/libs/theme.py b/libs/theme.py new file mode 100644 index 0000000..9859451 --- /dev/null +++ b/libs/theme.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python + +from resource import Resource +from shutil import copytree, ignore_patterns +from jinja2 import Template +import os + +class Theme: + + def __init__(self, path, resource_data): + res=Resource(path+"/resources.json") + self.theme_path=path.strip('/') + self.data=res.json + self.data.update(resource_data) + # Read theme + try: + with open(path+"/index.html",'r') as f: + self.template=Template(f.read()) + except IOError: + print("Unable to found "+resource) + exit(1) + + + def deploy(self, path): + copytree(self.theme_path, path, dirs_exist_ok=True,ignore=ignore_patterns("*.json","index.html")) + themes_dir=os.path.split(self.theme_path)[0] + theme_dir=os.path.split(self.theme_path)[1] + with open(path+"/index.html", "w") as index: + index.write(self.template.render(self.data)) diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..a62a99e --- /dev/null +++ b/setup.py @@ -0,0 +1,18 @@ +import setuptools + +with open("README.md", "r") as readme: + long_description = readme.read() + +setuptools.setup( + name="bcst", + version="0.0.1", + scripts=['bcst'], + author="Loic Guegan", + author_email="manzerbredes@mailbox.org", + description="A web browser start page generator.", + long_description=long_description, + url="https://gitlab.com/manzerbredes/bcst", + install_requires=["jinja2"], + packages=setuptools.find_packages(), + classifiers=["License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)"]) + diff --git a/src/args.py b/src/args.py deleted file mode 100644 index 6ae54bf..0000000 --- a/src/args.py +++ /dev/null @@ -1,9 +0,0 @@ -#!/usr/bin/env python - -import argparse - -args_parser = argparse.ArgumentParser() -args_parser.add_argument("resource", help="A JSON resource file.") -args_parser.add_argument("destination", help="Start page folder name.") -args = args_parser.parse_args() - diff --git a/src/bcst.py b/src/bcst.py deleted file mode 100755 index 850fbdb..0000000 --- a/src/bcst.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from args import args -from resource import Resource -from theme import Theme - - -res=Resource(args.resource) -t=Theme("themes/default",res.json) - -t.deploy(args.destination) diff --git a/src/resource.py b/src/resource.py deleted file mode 100644 index f521022..0000000 --- a/src/resource.py +++ /dev/null @@ -1,23 +0,0 @@ -#!/usr/bin/env python - -from os import path -import json, jsonschema - - -class Resource: - def __init__(self, resource): - self.resource=resource - # Read data - try: - with open(resource,'r') as f: - self.data=f.read() - except IOError: - print("Unable to found "+resource) - exit(1) - # Decode data - try: - self.json=json.loads(self.data) - except: - print("Unable to read json from "+resource) - exit(1) - diff --git a/src/theme.py b/src/theme.py deleted file mode 100644 index 9859451..0000000 --- a/src/theme.py +++ /dev/null @@ -1,29 +0,0 @@ -#!/usr/bin/env python - -from resource import Resource -from shutil import copytree, ignore_patterns -from jinja2 import Template -import os - -class Theme: - - def __init__(self, path, resource_data): - res=Resource(path+"/resources.json") - self.theme_path=path.strip('/') - self.data=res.json - self.data.update(resource_data) - # Read theme - try: - with open(path+"/index.html",'r') as f: - self.template=Template(f.read()) - except IOError: - print("Unable to found "+resource) - exit(1) - - - def deploy(self, path): - copytree(self.theme_path, path, dirs_exist_ok=True,ignore=ignore_patterns("*.json","index.html")) - themes_dir=os.path.split(self.theme_path)[0] - theme_dir=os.path.split(self.theme_path)[1] - with open(path+"/index.html", "w") as index: - index.write(self.template.render(self.data)) -- cgit v1.2.3