bcify 0.1.0__tar.gz

bcify-0.1.0/LICENSE

@@ -0,0 +1,58 @@
+Server-Lab Open-Control License (SOCL) 1.0 
+====================================
+Copyright (c) 2025 Sourasish Das
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+1. Attribution.
+   The original copyright notice and this license text must be retained in
+   all copies or substantial portions of the Software. If you distribute
+   compiled or packaged forms of the Software, you must include the copyright
+   notice and a copy of this license in a file distributed with those forms.
+2. Open-source grant.
+   The rights granted in this license are intended to be open-source in nature:
+   recipients may use, study, modify, and redistribute the Software under the
+   terms set forth herein.
+3. Ownership and control.
+   Copyright and all intellectual property rights in the Software are and remain
+   the exclusive property of the Copyright Owner named above. The Copyright
+   Owner retains sole authority to relicense, alter, or otherwise change the
+   licensing terms that apply to future distributions of the Software.
+4. License changes; effective date.
+   The Copyright Owner may change or replace this license at any time and
+   without notice. Any such change applies only to versions or distributions
+   of the Software that the Copyright Owner explicitly distributes after the
+   change takes effect. Copies of the Software already distributed by the
+   Copyright Owner under a prior version of this license remain governed by
+   the terms under which those copies were originally distributed.
+5. No trademark rights.
+   This license does not grant any rights to use the Copyright Owner's trade
+   names, trademarks, service marks, or logos.
+6. No warranty.
+   THE SOFTWARE IS PROVIDED "AS IS" AND THE COPYRIGHT OWNER DISCLAIMS ALL
+   WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
+   NON-INFRINGEMENT. USE OF THE SOFTWARE IS AT YOUR OWN RISK.
+7. Limitation of liability.
+   IN NO EVENT SHALL THE COPYRIGHT OWNER BE LIABLE FOR ANY CLAIM, DAMAGES OR
+   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+   DEALINGS IN THE SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+8. Contributor submissions.
+   By submitting a contribution to the project, a contributor grants the
+   Copyright Owner a perpetual, irrevocable, worldwide, royalty-free,
+   transferable license to use, reproduce, modify, distribute, sublicense,
+   and otherwise exploit the contribution as part of the Software.
+9. Termination.
+   This license and the rights granted hereunder will terminate automatically
+   if you fail to comply with any term of this license. Termination does not
+   affect any rights that were already granted to recipients prior to the
+   termination event with respect to copies distributed while the license was
+   in effect for that distribution.
+10. Governing law.
+    This license does not select a governing law; legal disputes shall be
+    governed by the laws applicable where enforcement is sought, subject to
+    applicable conflict-of-law rules.
+[END OF LICENSE]

bcify-0.1.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: bcify
+Version: 0.1.0
+Summary: Generate Bytecraft .bc scaffolds from existing project repositories.
+Author: Sourasish das
+License: MIT
+Keywords: bytecraft,scaffold,generator,cli
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Environment :: Console
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Dynamic: license-file
+
+# Bcify
+
+`Bcify` turns an existing project repository into a Bytecraft `.bc` scaffold script.
+
+It walks the repo, keeps probable text files, skips binary content, and emits a script
+made of `make-folder` and `make-file` commands that can recreate the text scaffold.
+
+## Install
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+```bash
+bcify path/to/repo
+bcify path/to/repo --output project.bc
+bcify path/to/repo --root-name cloned-project --include-hidden
+```
+
+By default, `bcify`:
+
+- writes `<repo-name>.bc` in the current working directory
+- skips common generated or tool directories like `.git`, `node_modules`, `.venv`, and `dist`
+- ignores files that do not look like text
+- preserves empty text files
+
+## Example
+
+```bash
+bcify ../my-app --output my-app.bc
+```
+
+Example output:
+
+```text
+# Generated by bcify from: ../my-app
+set-working-folder "my-app"
+
+make-folder "src"
+make-file "README.md" with ---
+# my-app
+---
+make-file "src/main.py" with ---
+print("hello")
+---
+```

bcify-0.1.0/README.md

@@ -0,0 +1,48 @@
+# Bcify
+
+`Bcify` turns an existing project repository into a Bytecraft `.bc` scaffold script.
+
+It walks the repo, keeps probable text files, skips binary content, and emits a script
+made of `make-folder` and `make-file` commands that can recreate the text scaffold.
+
+## Install
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+```bash
+bcify path/to/repo
+bcify path/to/repo --output project.bc
+bcify path/to/repo --root-name cloned-project --include-hidden
+```
+
+By default, `bcify`:
+
+- writes `<repo-name>.bc` in the current working directory
+- skips common generated or tool directories like `.git`, `node_modules`, `.venv`, and `dist`
+- ignores files that do not look like text
+- preserves empty text files
+
+## Example
+
+```bash
+bcify ../my-app --output my-app.bc
+```
+
+Example output:
+
+```text
+# Generated by bcify from: ../my-app
+set-working-folder "my-app"
+
+make-folder "src"
+make-file "README.md" with ---
+# my-app
+---
+make-file "src/main.py" with ---
+print("hello")
+---
+```

bcify-0.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bcify"
+version = "0.1.0"
+description = "Generate Bytecraft .bc scaffolds from existing project repositories."
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [
+  { name = "Sourasish das" }
+]
+license = { text = "MIT" }
+keywords = ["bytecraft", "scaffold", "generator", "cli"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "License :: OSI Approved :: MIT License",
+  "Environment :: Console"
+]
+
+[project.scripts]
+bcify = "bcify.cli:main"
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0"]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

bcify-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

bcify-0.1.0/src/bcify/__init__.py

@@ -0,0 +1,5 @@
+"""Bcify package."""
+
+__all__ = ["__version__"]
+
+__version__ = "0.1.0"

bcify-0.1.0/src/bcify/cli.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+import argparse
+from pathlib import Path
+
+from bcify.generator import build_scaffold_script
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="bcify",
+        description="Generate a Bytecraft .bc scaffold from a project repository.",
+    )
+    parser.add_argument("source", help="Path to the source repository or project folder.")
+    parser.add_argument(
+        "-o",
+        "--output",
+        help="Path to the output .bc file. Defaults to <repo-name>.bc in the current directory.",
+    )
+    parser.add_argument(
+        "--root-name",
+        help="Folder name used in set-working-folder. Defaults to the source folder name.",
+    )
+    parser.add_argument(
+        "--include-hidden",
+        action="store_true",
+        help="Include hidden files and directories except default ignored tool folders.",
+    )
+    return parser
+
+
+def main() -> int:
+    parser = build_parser()
+    args = parser.parse_args()
+
+    source = Path(args.source).expanduser().resolve()
+    if not source.exists():
+        parser.error(f"Source path does not exist: {source}")
+    if not source.is_dir():
+        parser.error(f"Source path must be a directory: {source}")
+
+    output = Path(args.output).expanduser().resolve() if args.output else Path.cwd() / f"{source.name}.bc"
+    root_name = args.root_name or source.name
+
+    script = build_scaffold_script(
+        source_dir=source,
+        root_name=root_name,
+        include_hidden=args.include_hidden,
+    )
+    output.write_text(script, encoding="utf-8", newline="\n")
+
+    print(f"Wrote scaffold: {output}")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

bcify-0.1.0/src/bcify/generator.py

@@ -0,0 +1,149 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+
+DEFAULT_IGNORED_DIRS = {
+    ".git",
+    ".hg",
+    ".svn",
+    ".idea",
+    ".vscode",
+    ".pytest_cache",
+    "__pycache__",
+    "node_modules",
+    ".venv",
+    "venv",
+    "dist",
+    "build",
+    "target",
+}
+
+DEFAULT_IGNORED_FILES = {
+    ".DS_Store",
+    "Thumbs.db",
+}
+
+TEXT_CHUNK_SIZE = 8192
+
+
+@dataclass(frozen=True)
+class RepoEntry:
+    path: Path
+    relative_path: Path
+    kind: str
+
+
+def build_scaffold_script(source_dir: Path, root_name: str, include_hidden: bool = False) -> str:
+    entries = collect_repo_entries(source_dir=source_dir, include_hidden=include_hidden)
+    lines = [
+        f"# Generated by bcify from: {source_dir}",
+        '# Non-text files were skipped automatically.',
+        f'set-working-folder "{escape_string(root_name)}"',
+        "",
+    ]
+
+    for entry in entries:
+        relative = entry.relative_path.as_posix()
+        if entry.kind == "dir":
+            lines.append(f'make-folder "{escape_string(relative)}"')
+            continue
+
+        content = entry.path.read_text(encoding=detect_text_encoding(entry.path))
+        lines.extend(
+            [
+                f'make-file "{escape_string(relative)}" with ---',
+                normalize_multiline_content(content),
+                "---",
+            ]
+        )
+
+    return "\n".join(lines).rstrip() + "\n"
+
+
+def collect_repo_entries(source_dir: Path, include_hidden: bool = False) -> list[RepoEntry]:
+    directories: list[RepoEntry] = []
+    files: list[RepoEntry] = []
+
+    for path in sorted(source_dir.rglob("*")):
+        relative = path.relative_to(source_dir)
+
+        if should_skip_path(relative, path, include_hidden=include_hidden):
+            continue
+
+        if path.is_dir():
+            directories.append(RepoEntry(path=path, relative_path=relative, kind="dir"))
+            continue
+
+        if path.is_file() and is_probably_text(path):
+            files.append(RepoEntry(path=path, relative_path=relative, kind="file"))
+
+    return directories + files
+
+
+def should_skip_path(relative: Path, path: Path, include_hidden: bool) -> bool:
+    parts = relative.parts
+    if any(part in DEFAULT_IGNORED_DIRS for part in parts):
+        return True
+
+    name = path.name
+    if name in DEFAULT_IGNORED_FILES:
+        return True
+
+    if include_hidden:
+        return False
+
+    return any(part.startswith(".") for part in parts)
+
+
+def is_probably_text(path: Path) -> bool:
+    try:
+        chunk = path.read_bytes()[:TEXT_CHUNK_SIZE]
+    except OSError:
+        return False
+
+    if not chunk:
+        return True
+
+    if b"\x00" in chunk:
+        return False
+
+    try:
+        chunk.decode("utf-8")
+        return True
+    except UnicodeDecodeError:
+        pass
+
+    for encoding in ("utf-16", "utf-16-le", "utf-16-be"):
+        try:
+            chunk.decode(encoding)
+            return True
+        except UnicodeDecodeError:
+            continue
+
+    printable = sum(
+        byte in b"\t\n\r\f\b" or 32 <= byte <= 126
+        for byte in chunk
+    )
+    return printable / len(chunk) >= 0.85
+
+
+def detect_text_encoding(path: Path) -> str:
+    raw = path.read_bytes()
+    for encoding in ("utf-8", "utf-16", "utf-16-le", "utf-16-be"):
+        try:
+            raw.decode(encoding)
+            return encoding
+        except UnicodeDecodeError:
+            continue
+    return "utf-8"
+
+
+def normalize_multiline_content(content: str) -> str:
+    normalized = content.replace("\r\n", "\n").replace("\r", "\n")
+    return normalized.rstrip("\n")
+
+
+def escape_string(value: str) -> str:
+    return value.replace("\\", "\\\\").replace('"', '\\"')

bcify-0.1.0/src/bcify.egg-info/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: bcify
+Version: 0.1.0
+Summary: Generate Bytecraft .bc scaffolds from existing project repositories.
+Author: Sourasish das
+License: MIT
+Keywords: bytecraft,scaffold,generator,cli
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Environment :: Console
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Dynamic: license-file
+
+# Bcify
+
+`Bcify` turns an existing project repository into a Bytecraft `.bc` scaffold script.
+
+It walks the repo, keeps probable text files, skips binary content, and emits a script
+made of `make-folder` and `make-file` commands that can recreate the text scaffold.
+
+## Install
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+```bash
+bcify path/to/repo
+bcify path/to/repo --output project.bc
+bcify path/to/repo --root-name cloned-project --include-hidden
+```
+
+By default, `bcify`:
+
+- writes `<repo-name>.bc` in the current working directory
+- skips common generated or tool directories like `.git`, `node_modules`, `.venv`, and `dist`
+- ignores files that do not look like text
+- preserves empty text files
+
+## Example
+
+```bash
+bcify ../my-app --output my-app.bc
+```
+
+Example output:
+
+```text
+# Generated by bcify from: ../my-app
+set-working-folder "my-app"
+
+make-folder "src"
+make-file "README.md" with ---
+# my-app
+---
+make-file "src/main.py" with ---
+print("hello")
+---
+```

bcify-0.1.0/src/bcify.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+src/bcify/__init__.py
+src/bcify/cli.py
+src/bcify/generator.py
+src/bcify.egg-info/PKG-INFO
+src/bcify.egg-info/SOURCES.txt
+src/bcify.egg-info/dependency_links.txt
+src/bcify.egg-info/entry_points.txt
+src/bcify.egg-info/requires.txt
+src/bcify.egg-info/top_level.txt
+tests/test_generator.py

bcify-0.1.0/src/bcify.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

bcify-0.1.0/src/bcify.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bcify = bcify.cli:main

bcify-0.1.0/src/bcify.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[dev]
+pytest>=8.0

bcify-0.1.0/src/bcify.egg-info/top_level.txt

@@ -0,0 +1 @@
+bcify

bcify-0.1.0/tests/test_generator.py

@@ -0,0 +1,30 @@
+from pathlib import Path
+
+from bcify.generator import build_scaffold_script, is_probably_text
+
+
+def test_build_scaffold_script_skips_binary_and_hidden(tmp_path: Path) -> None:
+    project = tmp_path / "sample"
+    project.mkdir()
+    (project / "src").mkdir()
+    (project / ".git").mkdir()
+    (project / "README.md").write_text("# Sample\n", encoding="utf-8")
+    (project / "src" / "main.py").write_text("print('hi')\n", encoding="utf-8")
+    (project / "image.png").write_bytes(b"\x89PNG\r\n\x1a\n\x00\x00binary")
+    (project / ".env").write_text("SECRET=test\n", encoding="utf-8")
+
+    script = build_scaffold_script(project, root_name="sample")
+
+    assert 'set-working-folder "sample"' in script
+    assert 'make-folder "src"' in script
+    assert 'make-file "README.md" with ---' in script
+    assert 'make-file "src/main.py" with ---' in script
+    assert "image.png" not in script
+    assert ".env" not in script
+
+
+def test_empty_file_is_treated_as_text(tmp_path: Path) -> None:
+    empty_file = tmp_path / "empty.txt"
+    empty_file.write_text("", encoding="utf-8")
+
+    assert is_probably_text(empty_file) is True