tinyssg 0.0.11__py3-none-any.whl → 1.0.0__py3-none-any.whl

tinyssg/__init__.py

@@ -548,7 +548,7 @@ class TinySSGLauncher:
         newargv = args.copy()
         newargv['mode'] = servcommand
 
-        command = [sys.executable, __file__, '--config', f"{json.dumps(newargv)}", 'config']
+        command = [sys.executable, '-m', 'tinyssg', '--config', f"{json.dumps(newargv)}", 'config']
 
         process = subprocess.Popen(
             command,
@@ -694,17 +694,17 @@ class TinySSG:
         """
         parser = argparse.ArgumentParser(prog='python -m tinyssg', description='TinySSG Simple Static Site Generate Tool')
         parser.add_argument('mode', choices=['dev', 'gen', 'cls', 'serv', 'servreload', 'config'], help='Select the mode to run (gen = Generate HTML files, dev = Run the debug server)')
-        parser.add_argument('--port', '-P', type=int, default=8000, help='Port number for the debug server')
         parser.add_argument('--page', '-p', type=str, default='pages', help='Page file path')
         parser.add_argument('--static', '-s', type=str, default='static', help='Static file path')
         parser.add_argument('--lib', '-l', type=str, default='libs', help='Library file path')
-        parser.add_argument('--input', '-i', type=str, default='', help='Input file name (Used to generate specific files only)')
         parser.add_argument('--output', '-o', type=str, default='dist', help='Output directory path')
+        parser.add_argument('--input', '-i', type=str, default='', help='Input file name (Used to generate specific files only)')
+        parser.add_argument('--curdir', '-C', type=str, default='', help='Current directory')
+        parser.add_argument('--port', '-P', type=int, default=8000, help='Port number for the debug server')
         parser.add_argument('--wait', '-w', type=int, default=5, help='Wait time for file change detection')
         parser.add_argument('--nolog', '-n', action='store_true', help='Do not output debug server log')
         parser.add_argument('--noreload', '-r', action='store_true', help='Do not reload the server when the file changes')
         parser.add_argument('--noopen', '-N', action='store_true', help='Do not open the browser when starting the server')
-        parser.add_argument('--curdir', '-C', type=str, default='', help='Current directory (For Jupyter)')
         parser.add_argument('--config', '-c', type=str, default='', help='Configuration json string')
         parser.add_argument('--jwidth', '-jw', type=str, default='600', help='Jupyter iframe width')
         parser.add_argument('--jheight', '-jh', type=str, default='600', help='Jupyter iframe height')

tinyssg-1.0.0.dist-info/METADATA

@@ -0,0 +1,142 @@
+Metadata-Version: 2.2
+Name: tinyssg
+Version: 1.0.0
+Summary: A simple static site generator
+Author: Uniras
+Author-email: tkappeng@gmail.com
+License: MIT License
+Project-URL: Homepage, https://github.com/uniras/tinyssg
+Project-URL: Repository, https://github.com/uniras/tinyssg
+Keywords: ssg,static site generator,html
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Description-Content-Type: text/markdown
+
+# TinySSG
+
+## Overview
+
+TinySSG is a simple static site generator with file-based routing.
+It combines simplicity and flexibility by writing pages in Python code with a simple structure.
+
+## Install
+
+```bash
+pip install tinyssg
+````
+
+## Usage
+
+### directory structure
+
+Configure the directory as follows.The directory name can be changed with an optional argument.
+
+```text
+  |-- pages Place Python files for SSG deployment.
+  |-- libs Place Python files that are not SSG target files (e.g. libraries).
+  |-- static Place static files that are not subject to SSG (css, images, etc.)
+  |-- dist This is the directory where SSG results will be output.The contents of this directory can be published as a web site by placing it on a web server.
+        |-- static The static directory is copied to this directory.
+````
+
+### Creating pages
+
+Create a Python file in the `pages` directory and create a class that extends the `TinySSGPage` class.
+
+```python
+from tinyssg import TinySSGPage
+
+class IndexPage(TinySSGPage):.
+    def query(self):.
+        return {
+            'title': 'Index', 'content': 'Hello, World!
+            'content': 'Hello, World!'
+        }
+
+    def template(self): return
+        return '''
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <title>{{ title }}</title>
+</head>
+<body>
+  <h1>{{ title }}</h1>
+  <p>{{ content }}</p>
+</body>
+</html>'''
+```
+
+Building it will generate an HTML file with the same name as the Python file.
+If multiple `TinySSGPage` inherited classes are defined in the Python file, the Python file name becomes the folder name and the class name in it becomes the HTML file name.
+
+The `query` method returns the data to be passed to the template, and the `template` method returns the HTML template.
+TinySSG uses the return values of these methods to generate HTML.
+
+The data returned by the `query` method must be in Python dictionary format or Python dictionary list format.
+In the case of dictionary format, an HTML file is generated with the python filename or class name, and in the case of list format, a directory is created equal to the python filename or class name, and by default, an HTML file is generated with a filename of .html, a number from 1.
+If a string representing a key name is returned with the list as a tuple on `return`, an HTML file is generated with the value corresponding to the key as the file name.
+
+By default, `TinySSG` simply replaces the parts of the template enclosed in `{{ key name }}` with the value corresponding to the key in the dictionary that is the return value of the `query` method,
+You can also override the `render` method for more complex processing, or use a template engine such as Jinja2.
+
+You can also define a process to convert the rendered text to final HTML by overriding the `translate` method.
+If you use the markdown library here to describe the process of conversion, you can write the template in Markdown instead of HTML.
+
+Each page must be defined individually, but since this is a simple Python class, if you want to apply it to multiple pages, you can create a class that defines the common parts and inherit it to easily apply it without copying any code.
+
+### Start local server for development.
+
+```bash
+python -m tinyssg dev
+```
+
+The local server for development will be started.You can see the generated HTML by accessing ``http://localhost:8000``.
+
+If you change files in the `pages`, `libs`, or `static` directories, the server will automatically restart to reflect the changes.
+
+### Generating HTML
+
+```bash
+python -m tinyssg gen
+```
+
+HTML files will be generated in the `dist` directory.
+
+### options (excerpt)
+
+```text
+
+usage: python -m tinyssg [--page PAGE] [--static STATIC] [--lib LIB] [--input INPUT] [--output OUTPUT] [--port PORT] [--wait WAIT] [--nolog] [--noreloadnoreload] [--noopen] [--curdir CURDIR] [mode]
+
+MODE:
+
+  Specifies startup mode (gen = generate HTML files, dev = start local server for development).
+
+Options:
+  --page PAGE, -p PAGE        Directory for page files
+  --static STATIC, -s STATIC  Directory for static files
+  --lib LIB, -l LIB           Directory for library files
+  --output OUTPUT, -o OUTPUT  Specify output directory.
+  --input INPUT, -i INPUT     Specifies which files to include in SSG (if not specified, all files in the directory are included).
+  --port PORT, -P PORT        Specify the port number of the development server.
+  --wait WAIT, -w WAIT        Wait time to prevent multiple restarts.
+  --nolog, -n                 Do not output request log to development server
+  --noreload, -r              Don't restart development server automatically.
+  --noopen, -N                Do not open browser when starting development server
+  --curdir CURDIR, -C CURDIR  Specify current directory.
+```

tinyssg-1.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+tinyssg/__init__.py,sha256=IX78iWBhjKJj1psk2wjqTh5HDUU3kTNd5licWpKY3cs,27408
+tinyssg/__main__.py,sha256=E8PEZ-wWYae76H_iWbY1Xu9VYGb6sfsWMN-hzqTMoBc,83
+tinyssg-1.0.0.dist-info/METADATA,sha256=gIWDqy6ZUA9tAZnfKvJ38ul9UbvjYBC8DaP0wNNbmWk,6039
+tinyssg-1.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+tinyssg-1.0.0.dist-info/top_level.txt,sha256=8u1XtPYCatbklb6u3NbJbFUbwA8nDKZ6cY3FScGwJDQ,8
+tinyssg-1.0.0.dist-info/RECORD,,

tinyssg-0.0.11.dist-info/METADATA

@@ -1,106 +0,0 @@
-Metadata-Version: 2.2
-Name: tinyssg
-Version: 0.0.11
-Summary: A simple static site generator
-Author: Uniras
-Author-email: tkappeng@gmail.com
-License: MIT License
-Project-URL: Homepage, https://github.com/uniras/tinyssg
-Project-URL: Repository, https://github.com/uniras/tinyssg
-Keywords: ssg,static site generator,html
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Utilities
-Description-Content-Type: text/markdown
-
-# TinySSG
-
-## 概要
-
-TinySSGは、ファイルベースルーティングのシンプルな静的サイトジェネレータです。
-ページを簡単な構造のTinySSGPageクラスを継承したPythonコードで記述することで単純さと柔軟性を両立しています。
-
-## インストール
-
-```bash
-pip install tinyssg
-```
-
-## 使い方
-
-### ディレクトリ構成
-
-以下のようにディレクトリを構成します。ディレクトリ名はオプション引数で変更可能です。
-
-```text
---- proect
-    |-- pages        SSGの対象となるPythonファイルを配置します
-    |-- libs         SSG・デプロイの対象にならないPythonファイルを配置します(ライブラリなど)
-    |-- static       SSGの対象にならない静的ファイルを配置します(css, 画像など)
-    |-- dist         SSGの結果が出力されるディレクトリです。このディレクトリの中身をWebサーバに配置することでWebサイトとして公開できます。
-         |-- static  staticディレクトリはこのディレクトリにコピーされます
-```
-
-pages, libs, staticディレクトリは、開発サーバー起動時に監視され、ファイルが変更されると自動的にサーバーを再起動します。
-
-### ページの作成
-
-`Page`ディレクトリ内にPythonファイルを作り、`TinySSGPage`クラスを継承したクラスを作成します。
-
-```python
-from tinyssg import TinySSGPage
-
-class IndexPage(TinySSGPage):
-    def query(self):
-        return {
-            'title': 'Index',
-            'content': 'Hello, World!'
-        }
-
-    def template(self):
-        return '''
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="utf-8" />
-  <title>{{ title }}</title>
-</head>
-<body>
-  <h1>{{ title }}</h1>
-  <p>{{ content }}</p>
-</body>
-</html>'''
-```
-
-`query`メソッドでテンプレートに渡すデータを返し、`template`メソッドでHTMLテンプレートを返します。
-TinySSGは、これらのメソッドの返り値を使ってHTMLを生成します。
-
-`query`メソッドが返すデータは、Python辞書形式またはPython辞書のリスト形式である必要があります。
-辞書形式の場合はpythonファイル名のHTMLファイルが生成され、リスト形式の場合はPythonファイル名と同じディレクトリが作成され、デフォルトでは1からの数字.htmlのファイル名でHTMLファイルが生成されます。
-`return`の際にタプルとしてリストと一緒にキー名を表す文字列を返すと、そのキーに対応する値をファイル名としてHTMLファイルが生成されます。
-
-`TinySSG`はデフォルトでは単純にテンプレートの`{{ キー名 }}`で囲まれた部分を`query`メソッドの返り値である辞書のキーに対応する値で単純に置換するだけですが、
-`render`メソッドをオーバーライドすることで、より複雑な処理を行うこともできます。Jinja2などのテンプレートエンジンを使うこともできます。
-
-また、`translate`メソッドをオーバーライドすることで、レンダー後のテキストを最終的なHTMLに変換する処理を定義することもできます。
-ここでmarkdownライブラリを使って変換する処理を記述すればテンプレートをHTMLではなくMarkdownで記述することができます。
-
-それぞれページごとに定義することになりますが、単純なPythonクラスですので複数のページに適用したい場合は共通部分を定義したクラスを作成し、それを継承することでコードをコピーすることなく簡単に適用することができます。
-
-### HTMLの生成
-
-```bash
-python -m tinyssg gen
-```

tinyssg-0.0.11.dist-info/RECORD

@@ -1,6 +0,0 @@
-tinyssg/__init__.py,sha256=uaCHaXdBRlKRWy4sdsPLIn738hEqQfWkxF7KUjUmon0,27415
-tinyssg/__main__.py,sha256=E8PEZ-wWYae76H_iWbY1Xu9VYGb6sfsWMN-hzqTMoBc,83
-tinyssg-0.0.11.dist-info/METADATA,sha256=L-Ggr4WRH7krJLrADUSuI5jYjb-fzDr6Irqnm82nCjo,5069
-tinyssg-0.0.11.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-tinyssg-0.0.11.dist-info/top_level.txt,sha256=8u1XtPYCatbklb6u3NbJbFUbwA8nDKZ6cY3FScGwJDQ,8
-tinyssg-0.0.11.dist-info/RECORD,,